Events API v2 - GET an event
Gets all properties of the specified event.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId} | |
| Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/events/{eventId} |
Authentication
To execute this request, you need an access token with events.read scope.
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 | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Event | Success. The response contains the configuration of the event. |
Response body objects
The Event object
Configuration of an event.
| Element | Type | Description |
|---|---|---|
| correlationId | string | The correlation ID of the event. |
| endTime | integer | The timestamp when the event was closed, in UTC milliseconds. Has the value of |
| entityId | EntityStub | A short representation of a monitored entity. |
| entityTags | METag[] | A list of tags of the related entity. |
| eventId | string | The ID of the event. |
| eventType | string | The type of the event. |
| frequentEvent | boolean | If A frequent event doesn't raise a problem. |
| managementZones | ManagementZone[] | A list of all management zones that the event belongs to. |
| properties | EventProperty[] | A list of event properties. |
| startTime | integer | The timestamp when the event was raised, in UTC milliseconds. |
| status | string | The status of the event.
|
| suppressAlert | boolean | The alerting status during a maintenance:
|
| suppressProblem | boolean | The problem detection status during a maintenance:
|
| title | string | The title of the event. |
| underMaintenance | boolean | If |
The EntityStub object
A short representation of a monitored entity.
| Element | Type | Description |
|---|---|---|
| entityId | EntityId | A short representation of a monitored entity. |
| name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the entity. |
| type | string | The type of the entity. |
The METag object
The tag of a monitored entity.
| Element | Type | Description |
|---|---|---|
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
| key | string | The key of the tag. |
| stringRepresentation | string | The string representation of the tag. |
| value | string | The value of the tag. |
The ManagementZone object
A short representation of a management zone.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the management zone. |
| name | string | The name of the management zone. |
The EventProperty object
A property of an event.
| Element | Type | Description |
|---|---|---|
| key | string | The key of the event property. |
| value | string | The value of the event property. |
Response body JSON model
1{2 "correlationId": "933613657e1c8fcf",3 "endTime": 1564039524182,4 "entityId": {5 "entityId": {6 "id": "string",7 "type": "string"8 },9 "name": "string"10 },11 "entityTags": [12 {13 "context": "string",14 "key": "string",15 "stringRepresentation": "string",16 "value": "string"17 }18 ],19 "eventId": "4293884258445543163_1564039524182",20 "eventType": "LOW_DISK_SPACE",21 "frequentEvent": true,22 "managementZones": [23 {24 "id": "string",25 "name": "string"26 }27 ],28 "properties": [29 {30 "key": "string",31 "value": "string"32 }33 ],34 "startTime": 1564039524182,35 "status": "OPEN",36 "suppressAlert": true,37 "suppressProblem": true,38 "title": "High CPU load on host X",39 "underMaintenance": true40}
Example
In this example, the request queries the parameters of the event with the ID of 6375436663535938547_1628496488654.
This is the SYNTHETIC_GLOBAL_OUTAGE event, indicating global outage of browser monitors.
The API token is passed in the Authorization header.
Curl
1curl --request GET \2 --url https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654 \3 --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
1https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654
Response body
1{2 "eventId": "6375436663535938547_1628496488654",3 "startTime": 1628496488654,4 "endTime": 1628503679796,5 "eventType": "SYNTHETIC_GLOBAL_OUTAGE",6 "title": "Browser monitor global outage",7 "entityId": {8 "entityId": {9 "id": "SYNTHETIC_TEST-03ABB7F6446D1727",10 "type": "SYNTHETIC_TEST"11 },12 "name": "Maintenance window test"13 },14 "properties": [15 {16 "key": "dt.event.group_label",17 "value": "Browser monitor global outage"18 },19 {20 "key": "dt.event.is_rootcause_relevant",21 "value": "true"22 }23 ],24 "status": "CLOSED",25 "correlationId": "aecd1653df38ef50",26 "entityTags": [27 {28 "context": "CONTEXTLESS",29 "key": "Synthetic",30 "value": "Browser",31 "stringRepresentation": "Synthetic:Browser"32 }33 ],34 "managementZones": [35 {36 "id": "-7832237287622819191",37 "name": "Synthetic tests"38 }39 ],40 "underMaintenance": true,41 "suppressAlert": false,42 "suppressProblem": false,43 "frequentEvent": false44}
Response code
200