Events API v2 - GET an event

Gets all properties of the specified event.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/events/{eventId}
Environment ActiveGateCluster ActiveGatehttps://{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

Success. The response contains the configuration of the event.

4XX

Client side error.

5XX

Server side error.

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 null if the event is still active.

entityId

A short representation of a monitored entity.

entityTags

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 true, the event happens frequently.

A frequent event doesn't raise a problem.

managementZones

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

properties

A list of event properties.

startTime
integer

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

status
string

The status of the event.

  • CLOSED
  • OPEN
suppressAlert
boolean

The alerting status during a maintenance:

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

The problem detection status during a maintenance:

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

The title of the event.

underMaintenance
boolean

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

The EntityStub object

A short representation of a monitored entity.

Element
Type
Description
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 CONTEXTLESS value.

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

{
  "correlationId": "933613657e1c8fcf",
  "endTime": 1564039524182,
  "entityId": {
    "entityId": {
      "id": "string",
      "type": "string"
    },
    "name": "string"
  },
  "entityTags": [
    {
      "context": "string",
      "key": "string",
      "stringRepresentation": "string",
      "value": "string"
    }
  ],
  "eventId": "4293884258445543163_1564039524182",
  "eventType": "LOW_DISK_SPACE",
  "frequentEvent": true,
  "managementZones": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "properties": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "startTime": 1564039524182,
  "status": "OPEN",
  "suppressAlert": true,
  "suppressProblem": true,
  "title": "High CPU load on host X",
  "underMaintenance": true
}

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_1628496488654

Response 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

Related topics