• Home
  • Dynatrace API
  • Environment
  • Events v2
  • GET an event

Events API v2 - GET an event

Gets all properties of the specified event.

The request produces an application/json payload.

GETManaged 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 an access token with Read events (events.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
eventIdstring

The ID of the required event.

pathrequired

Response

Response codes

CodeTypeDescription
200Event

Success. The response contains the configuration of the event.

Response body objects

The Event object

Configuration of an event.

ElementTypeDescription
managementZonesManagementZone[]

A list of all management zones that the event belongs to.

Can be null.

underMaintenanceboolean

If true, the event happened while the monitored system was under maintenance.

Can be null.

suppressAlertboolean

The alerting status during a maintenance:

  • false: Alerting works as usual.
  • true: Alerting is disabled.

Can be null.

suppressProblemboolean

The problem detection status during a maintenance:

  • false: Problem detection works as usual.
  • true: Problem detection is disabled.

Can be null.

frequentEventboolean

If true, the event happens frequently.

A frequent event doesn't raise a problem.

Can be null.

entityIdEntityStub

A short representation of a monitored entity.

Can be null.

eventIdstring

The ID of the event.

Can be null.

entityTagsMETag[]

A list of tags of the related entity.

Can be null.

eventTypestring

The type of the event.

Can be null.

propertiesEventProperty[]

A list of event properties.

Can be null.

statusstring

The status of the event.

The element can hold these values
  • CLOSED
  • OPEN

Can be null.

startTimeinteger

The timestamp when the event was raised, in UTC milliseconds.

Can be null.

endTimeinteger

The timestamp when the event was closed, in UTC milliseconds.

Has the value of null if the event is still active.

Can be null.

titlestring

The title of the event.

Can be null.

correlationIdstring

The correlation ID of the event.

Can be null.

The ManagementZone object

A short representation of a management zone.

ElementTypeDescription
namestring

The name of the management zone.

Can be null.

idstring

The ID of the management zone.

Can be null.

The EntityStub object

A short representation of a monitored entity.

ElementTypeDescription
entityIdEntityId

A short representation of a monitored entity.

Can be null.

namestring

The name of the entity.

Not included in the response in case no entity with the relevant ID was found.

Can be null.

The EntityId object

A short representation of a monitored entity.

ElementTypeDescription
idstring

The ID of the entity.

Can be null.

typestring

The type of the entity.

Can be null.

The METag object

The tag of a monitored entity.

ElementTypeDescription
stringRepresentationstring

The string representation of the tag.

Can be null.

valuestring

The value of the tag.

Can be null.

keystring

The key of the tag.

Can be null.

contextstring

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

Can be null.

The EventProperty object

A property of an event.

ElementTypeDescription
valuestring

The value of the event property.

Can be null.

keystring

The key of the event property.

Can be null.

Response body JSON model

json
{ "managementZones": [ { "name": "string", "id": "string" } ], "underMaintenance": true, "suppressAlert": true, "suppressProblem": true, "frequentEvent": true, "entityId": { "entityId": { "id": "string", "type": "string" }, "name": "string" }, "eventId": "4293884258445543163_1564039524182", "entityTags": [ { "stringRepresentation": "string", "value": "string", "key": "string", "context": "string" } ], "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

shell
curl --request GET \ --url https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654 \ --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/events/6375436663535938547_1628496488654

Response body

json
{ "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

Related topics
  • Event types

    Learn the supported event types, along with their severity levels, and the logic behind raising them.

  • Event analytics

    Gain an understanding of the Events section on each host, process, and service overview page.