Events API v1 - GET an event
Lists parameters of the specified event.
The request produces an application/json payload.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/events/{eventId} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/events/{eventId} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events/{eventId} |
Authentication
To execute this request, you need Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| eventId | string | The ID of the required event. | path | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Event | Success |
Response body objects
The EventRestEntry object
Set of parameters of the event.
Apart from the general properties mentioned here, which each event has, an actual event has a set of metadata that varies depending on the event type.
| Element | Type | Description | Required |
|---|---|---|---|
| startTime | integer | The timestamp of the event detection, in UTC milliseconds. | optional |
| endTime | integer | The timestamp of the event closure, in UTC milliseconds | optional |
| entityId | string | The ID of the affected Dynatrace entity. | optional |
| entityName | string | The name of the affected Dynatrace entity. | optional |
| severityLevel | string | The severity of the event. | optional |
| impactLevel | string | The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. | optional |
| eventType | string | The type of the event. | optional |
| resourceId | string | The id of the resource the event occurred on. | optional |
| resourceName | string | The name of the resource the event occurred on. | optional |
| eventStatus | string | The state of the event: open or closed. | optional |
| tags | Tag | Tags of the Dynatrace entity that raised the event. | optional |
| id | string | The encoded ID of the event. The format is eventID_startTime. You should use the value from this field when you need an event ID. | optional |
The TagInfo object
Tag of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the | required |
| key | string | The key of the tag. Custom tags have the tag value here. | required |
| value | string | The value of the tag. Not applicable to custom tags. | optional |
Response body JSON model
{
"startTime": 1521042929000,
"endTime": 1521542929000,
"entityId": "HOST-0000000000000007",
"entityName": "Example Host",
"severityLevel": "PERFORMANCE",
"impactLevel": "INFRASTRUCTURE",
"eventType": "SLOW_DISK",
"eventStatus": "OPEN",
"tags": [
{
"context": "CONTEXTLESS",
"key": "exampleTag"
}
],
"id": "5915682011263205071_1521042929000",
"source": "builtin"
}Example
In this example, the request queries the parameters of the event with the ID 4166694657638834567_1533134704285.
This is the CUSTOM_DEPLOYMENT event-affected service and is marked with the deploy custom tag.
The API token is passed in the Authorization header.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v1/events/4166694657638834567_1533134704285 \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/events/4166694657638834567_1533134704285Response content
{
"eventId": 4166694657638834567,
"startTime": 1533134704285,
"endTime": 1533134704285,
"entityId": "SERVICE-0F579DCA105F190C",
"entityName": "wmqiTestingWeb",
"severityLevel": null,
"impactLevel": "SERVICE",
"eventType": "CUSTOM_DEPLOYMENT",
"eventStatus": "CLOSED",
"tags": [
{
"context": "CONTEXTLESS",
"key": "deploy"
}
],
"id": "4166694657638834567_1533134704285",
"customProperties": {
"Build Number": "1.223.23432",
"Owner": "Jason Miller (jason.miller@easytravel.com)",
"Approver": "Alice McBright (alice.mcbright@easytravel.com)",
"Git commit": "e5afbftc7eb"
},
"deploymentProject": "easyTravel service",
"remediationAction": "http://tower.local/job/RemediateJob/38/",
"deploymentVersion": "1.23.321",
"deploymentName": "easyTravel service deployment",
"source": "ServiceNow",
"ciBackLink": "http://tower.local/job/DeployJob/38/artifact/build/Deployment-v1.23.321.zip"
}Response code
200