Events API v2 - GET an event type

Reference
Published Aug 06, 2021

Gets the properties of an event type.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/eventTypes/{eventType}`
GET	Environment ActiveGateCluster ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/eventTypes/{eventType}`

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
eventType	string	The event type you're inquiring.	path	Required

Response

Response codes

Code	Type	Description
200	EventType	Success
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `EventType` object

Configuration of an event type.

Element	Type	Description
description	string	A short description of the event type.
displayName	string	The display name of the event type.
severityLevel	string	The severity level associated with the event type. The element can hold these values `AVAILABILITY` `CUSTOM_ALERT` `ERROR` `INFO` `MONITORING_UNAVAILABLE` `PERFORMANCE` `RESOURCE_CONTENTION`
type	string	The event type.

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "description": "string",
  "displayName": "High CPU",
  "severityLevel": "PERFORMANCE",
  "type": "OSI_HIGH_CPU"
}

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Example

In this example, the request queries the properties of the APPLICATION_SLOWDOWN type.

The API token is passed in the Authorization header.

Curl

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

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/eventTypes/APPLICATION_SLOWDOWN

Response body

{
  "type": "APPLICATION_SLOWDOWN",
  "displayName": "Application slowdown",
  "severityLevel": "PERFORMANCE",
  "description": "User action duration degradation"
}

Response code

200