Events API v2 - GET an event
Gets all properties of the specified event.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/events/{eventId} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/events/{eventId} |
Authentication
To execute this request, you need Read events (events.read) 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 | 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 | Required |
|---|---|---|---|
| suppressAlert | boolean | The alerting status during a maintenance:
| optional |
| frequentEvent | boolean | If A frequent event doesn't raise a problem. | optional |
| underMaintenance | boolean | If | optional |
| suppressProblem | boolean | The problem detection status during a maintenance:
| optional |
| entityTags | M | A list of tags of the related entity. | optional |
| managementZones | Management | A list of all management zones that the event belongs to. | optional |
| entityId | Entity | A short representation of a monitored entity. | optional |
| eventId | string | The ID of the event. | optional |
| eventType | string | The type of the event. | optional |
| properties | Event | A list of event properties. | optional |
| status | string | The status of the event. | optional |
| startTime | integer | The timestamp when the event was raised, in UTC milliseconds. | optional |
| endTime | integer | The timestamp when the event was closed, in UTC milliseconds. Has the value of | optional |
| title | string | The title of the event. | optional |
| correlationId | string | The correlation ID of the event. | optional |
The METag object
The tag of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| stringRepresentation | string | The string representation of the tag. | optional |
| value | string | The value of the tag. | optional |
| key | string | The key of the tag. | optional |
| context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the | optional |
The ManagementZone object
A short representation of a management zone.
| Element | Type | Description | Required |
|---|---|---|---|
| name | string | The name of the management zone. | optional |
| id | string | The ID of the management zone. | optional |
The EntityStub object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| entityId | Entity | A short representation of a monitored entity. | optional |
| name | string | The name of the entity. Not included in the response in case no entity with the relevant ID was found. | optional |
The EntityId object
A short representation of a monitored entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the entity. | optional |
| type | string | The type of the entity. | optional |
The EventProperty object
A property of an event.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string | The value of the event property. | optional |
| key | string | The key of the event property. | optional |
Response body JSON model
{
"suppressAlert": true,
"frequentEvent": true,
"underMaintenance": true,
"suppressProblem": true,
"entityTags": [
{
"stringRepresentation": "string",
"value": "string",
"key": "string",
"context": "string"
}
],
"managementZones": [
{
"name": "string",
"id": "string"
}
],
"entityId": {
"entityId": {
"id": "string",
"type": "string"
},
"name": "string"
},
"eventId": "4293884258445543163_1564039524182",
"eventType": "LOW_DISK_SPACE",
"properties": [
{
"value": "string",
"key": "string"
}
],
"status": "OPEN",
"startTime": 1564039524182,
"endTime": 1564039524182,
"title": "High CPU load on host X",
"correlationId": "933613657e1c8fcf"
}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
curl --request GET \
--url https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654 \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654Response body
{
"eventId": "6375436663535938547_1628496488654",
"startTime": 1628496488654,
"endTime": 1628503679796,
"eventType": "SYNTHETIC_GLOBAL_OUTAGE",
"title": "Browser monitor global outage",
"entityId": {
"entityId": {
"id": "SYNTHETIC_TEST-03ABB7F6446D1727",
"type": "SYNTHETIC_TEST"
},
"name": "Maintenance window test"
},
"properties": [
{
"key": "dt.event.group_label",
"value": "Browser monitor global outage"
},
{
"key": "dt.event.is_rootcause_relevant",
"value": "true"
}
],
"status": "CLOSED",
"correlationId": "aecd1653df38ef50",
"entityTags": [
{
"context": "CONTEXTLESS",
"key": "Synthetic",
"value": "Browser",
"stringRepresentation": "Synthetic:Browser"
}
],
"managementZones": [
{
"id": "-7832237287622819191",
"name": "Synthetic tests"
}
],
"underMaintenance": true,
"suppressAlert": false,
"suppressProblem": false,
"frequentEvent": false
}Response code
200