Events API v2 - POST an event
Ingests a custom event to Dynatrace.
The request consumes an application/json
payload.
The ingestion of custom events consumes Davis Data Units (DDUs) from the events pool.
POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/events/ingest |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/events/ingest | |
Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/events/ingest |
Authentication
To execute this request, you need an access token with events.ingest
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | EventIngest | The JSON body of the request. Contains properties of the new event. | body | optional |
Request body objects
The EventIngest
object
The configuration of an event to be ingested.
Element | Type | Description | Required |
---|---|---|---|
endTime | integer | The end time of the event, in UTC milliseconds. If not set, the start time plus timeout is used. | optional |
entitySelector | string | The entity selector, defining a set of Dynatrace entities to be associated with the event. Only entities that have been active within the last 24 hours can be selected. If not set, the event is associated with the environment ( | optional |
eventType | string | The type of the event.
| required |
properties | object | A map of event properties. Keys with prefix Values of Dynatrace-reserved properties must fulfill the requirements of the respective property. A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters. | optional |
startTime | integer | The start time of the event, in UTC milliseconds. If not set, the current timestamp is used. Depending on the event type, the start time must not lie in the past more than 6 hours for problem-opening events and 30 days for info events. Depending on the event type, the start time must not lie in the future more than 5 minutes for problem-opening events and 7 days for info events. | optional |
timeout | integer | The timeout of the event, in minutes. If not set, 15 is used. The timeout will automatically be capped to a maximum of 360 minutes (6 hours). Problem-opening events can be refreshed and therefore kept open by sending the same payload again. | optional |
title | string | The title of the event. | required |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"endTime": 1,"entitySelector": "string","eventType": "AVAILABILITY_EVENT","properties": {},"startTime": 1,"timeout": 1,"title": "string"}
Response
Response codes
Code | Type | Description |
---|---|---|
201 | EventIngestResults | The event ingest request was received by the server. The response body indicates for each event whether its creation was successful. |
4XX | ErrorEnvelope | Client side error. |
5XX | ErrorEnvelope | Server side error. |
Response body objects
The EventIngestResults
object
The results of an event ingest.
Element | Type | Description |
---|---|---|
eventIngestResults | EventIngestResult[] | The result of each created event report. |
reportCount | integer | The number of created event reports. |
The EventIngestResult
object
The result of a created event report.
Element | Type | Description |
---|---|---|
correlationId | string | The correlation ID of the created event. |
status | string | The status of the ingestion.
|
Response body JSON model
{"eventIngestResults": [{"correlationId": "string","status": "INVALID_ENTITY_TYPE"}],"reportCount": 1}