Events API v1 - POST an event
This API is deprecated. Use the Events API v2 instead.
Pushes custom events from third-party integrations to one or more monitored entities.
This endpoint enables third-party systems such as CI platforms (Jenkins, Bamboo, Electric Cloud, etc.) to provide additional details for Dynatrace automated root cause analysis.
You can use this endpoint to:
- Push information-only events from third-party systems to provide additional information for Dynatrace automated root cause analysis. The time of event closure is already known and the event IDs are returned instantly. You can push these events for up to 30 days into the past. The information-only event types are:
CUSTOM_ANNOTATIONCUSTOM_CONFIGURATIONCUSTOM_DEPLOYMENTCUSTOM_INFOMARKED_FOR_TERMINATION
- Push problem-opening events (for example, an error rate increase) to trigger the Dynatrace automated root cause analysis engine. Correlation IDs are returned instead of event IDs. These events stay open until the specified timeout expires. To prevent expiration, you can refresh these events by sending the same payload again. You can push these events for up to 60 minutes into the past. The problem-opening event types (sorted by highest to lowest severity) are:
AVAILABILITY_EVENTERROR_EVENTPERFORMANCE_EVENTRESOURCE_CONTENTION
The request consumes and produces an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/events |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/events |
Authentication
To execute this request, you need an access token with DataExport scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The set of parameters depends on the event type. See Parameters mapping below for details.
Request body objects
The EventCreation object
Configuration of the custom event.
Allow Davis AI to merge this event into existing problems (true) or force creating a new problem (false).
This only applies to problem-opening event types.
A detailed description of the custom annotation, for example DNS route has been changed to x.mydomain.com.
The type of the custom annotation, for example DNS route has been changed.
The set of rules defining Dynatrace entities to be associated with the event.
You can specify tags to dynamically match Dynatrace entities or IDs of specific entities.
At least one entity ID or tag is required.
The new value of the configuration that has been set by the event.
The link to the deployed artifact within the 3rd party system.
The ID or the name of the configuration that has been changed by the event.
The set of any properties related to the event, in the "key" : "value" format.
The ID of the triggered deployment.
The project name of the deployed package.
The version of the triggered deployment.
The textual description of the configuration change.
The end timestamp of the event, in UTC milliseconds.
If not set, the current time is used for information-only events.
Not applicable to problem-opening events. Such an event stays open until it times out depending on the timeoutMinutes parameter.
The type of the event.
AVAILABILITY_EVENTCUSTOM_ALERTCUSTOM_ANNOTATIONCUSTOM_CONFIGURATIONCUSTOM_DEPLOYMENTCUSTOM_INFOERROR_EVENTMARKED_FOR_TERMINATIONPERFORMANCE_EVENTRESOURCE_CONTENTION
The previous value of the configuration.
The link to the deployment related remediation action within the external tool.
The name or ID of the external source of the event.
The start timestamp of the event, in UTC milliseconds.
If not set, the current timestamp is used.
You can report information-only events up to 30 days into the past.
You can report problem-opening events up to 60 minutes into the past.
The timeout for problem-opening events in minutes. Not applicable to information-only events.
If not set, 15 minutes is used. The maximum allowed value is 120 minutes.
You can refresh the event by sending the same payload again.
A list of timeseries IDs, related to the event.
The title of the configuration that has been set by the event.
The PushEventAttachRules object
The set of rules defining Dynatrace entities to be associated with the event.
You can specify tags to dynamically match Dynatrace entities or IDs of specific entities.
At least one entity ID or tag is required.
A list of entity IDs to which the event should be attached.
A set of matching rules to dynamically pick up entities based on tags.
Only entities seen within the last 24 hours are taken into account for tag-based matching rules.
The TagMatchRule object
The list of tags to be used for matching Dynatrace entities.
The list of types of the Dynatrace entities (for example hosts or services) you want to pick up by matching.
APM_SECURITY_GATEWAYAPPLICATIONAPPLICATION_METHODAPPLICATION_METHOD_GROUPAPPMON_SERVERAPPMON_SYSTEM_PROFILEAUTO_SCALING_GROUPAUXILIARY_SYNTHETIC_TESTAWS_APPLICATION_LOAD_BALANCERAWS_AVAILABILITY_ZONEAWS_CREDENTIALSAWS_LAMBDA_FUNCTIONAWS_NETWORK_LOAD_BALANCERAZURE_API_MANAGEMENT_SERVICEAZURE_APPLICATION_GATEWAYAZURE_APP_SERVICE_PLANAZURE_COSMOS_DBAZURE_CREDENTIALSAZURE_EVENT_HUBAZURE_EVENT_HUB_NAMESPACEAZURE_FUNCTION_APPAZURE_IOT_HUBAZURE_LOAD_BALANCERAZURE_MGMT_GROUPAZURE_REDIS_CACHEAZURE_REGIONAZURE_SERVICE_BUS_NAMESPACEAZURE_SERVICE_BUS_QUEUEAZURE_SERVICE_BUS_TOPICAZURE_SQL_DATABASEAZURE_SQL_ELASTIC_POOLAZURE_SQL_SERVERAZURE_STORAGE_ACCOUNTAZURE_SUBSCRIPTIONAZURE_TENANTAZURE_VMAZURE_VM_SCALE_SETAZURE_WEB_APPBROWSERCF_APPLICATIONCF_FOUNDATIONCINDER_VOLUMECLOUD_APPLICATIONCLOUD_APPLICATION_INSTANCECLOUD_APPLICATION_NAMESPACECLOUD_NETWORK_INGRESSCLOUD_NETWORK_POLICYCONTAINER_GROUPCONTAINER_GROUP_INSTANCECUSTOM_APPLICATIONCUSTOM_DEVICECUSTOM_DEVICE_GROUPDCRUM_APPLICATIONDCRUM_SERVICEDCRUM_SERVICE_INSTANCEDEVICE_APPLICATION_METHODDEVICE_APPLICATION_METHOD_GROUPDISKDOCKER_CONTAINER_GROUPDOCKER_CONTAINER_GROUP_INSTANCEDYNAMO_DB_TABLEEBS_VOLUMEEC2_INSTANCEELASTIC_LOAD_BALANCERENVIRONMENTEXTERNAL_SYNTHETIC_TEST_STEPGCP_ZONEGEOLOCATIONGEOLOC_SITEGOOGLE_COMPUTE_ENGINEHOSTHOST_GROUPHTTP_CHECKHTTP_CHECK_STEPHYPERVISORHYPERVISOR_CLUSTERHYPERVISOR_DISKKUBERNETES_CLUSTERKUBERNETES_NODEKUBERNETES_SERVICEMOBILE_APPLICATIONMULTIPROTOCOL_MONITORNETWORK_INTERFACENEUTRON_SUBNETOPENSTACK_PROJECTOPENSTACK_REGIONOPENSTACK_VMOSPROCESS_GROUPPROCESS_GROUP_INSTANCEQUEUEQUEUE_INSTANCERELATIONAL_DATABASE_SERVICES3BUCKETSERVICESERVICE_INSTANCESERVICE_METHODSERVICE_METHOD_GROUPSWIFT_CONTAINERSYNTHETIC_LOCATIONSYNTHETIC_TESTSYNTHETIC_TEST_STEPVCENTERVIRTUALMACHINEVMWARE_DATACENTER
The list of tags you want to use for matching. At least one tag is required.
You can use custom tags from the UI, imported tags, and tags based on environment variables.
The TagInfo object
Tag of a Dynatrace entity.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_CLOUDKUBERNETES
The key of the tag.
Custom tags have the tag value here.
The value of the tag.
Not applicable to custom tags.
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.
{"annotationDescription": "The coffee machine is broken","annotationType": "defect","attachRules": {"entityIds": ["CUSTOM_DEVICE-0000000000000007"],"tagRule": [{"meTypes": ["HOST"],"tags": [{"context": "CONTEXTLESS","key": "customTag"}]}]},"end": 1521542929000,"eventType": "CUSTOM_ANNOTATION","source": "OpsControl","start": 1521042929000}
Parameters mapping
Availability event
Custom annotation
Custom config
Custom deployment
Custom info
Error event
Performance event
Resource contention
Marked for termination
description
req
opt
req
n/a
req
req
req
req
req
title
req
n/a
n/a
n/a
opt
req
req
req
opt
source
req
req
req
req
req
req
req
req
req
annotationType
n/a
req
n/a
n/a
n/a
n/a
n/a
n/a
n/a
annotationDescription
n/a
req
n/a
n/a
n/a
n/a
n/a
n/a
n/a
deploymentName
n/a
n/a
n/a
req
n/a
n/a
n/a
n/a
n/a
deploymentVersion
n/a
n/a
n/a
req
n/a
n/a
n/a
n/a
n/a
deploymentProject
n/a
n/a
n/a
opt
n/a
n/a
n/a
n/a
n/a
ciBackLink
n/a
n/a
n/a
opt
n/a
n/a
n/a
n/a
opt
remediationAction
n/a
n/a
n/a
opt
n/a
n/a
n/a
n/a
n/a
original
n/a
n/a
opt
n/a
n/a
n/a
n/a
n/a
n/a
configuration
n/a
n/a
req
n/a
n/a
n/a
n/a
n/a
n/a
customProperties
opt
opt
opt
opt
opt
opt
opt
opt
opt
Response
Response codes
Response body objects
The EventStoreResult object
Contains IDs of all custom events, created by an event push call.
List of correlation IDs for problem-opening-events.
List of event IDs for information-only-events.
This field is provided for compatibility reasons. You should use the values from the storedIds field instead.
List of encoded event IDs for information-only-events.
Response body JSON model
{"storedCorrelationIds": ["string"],"storedEventIds": [1],"storedIds": ["string"]}
Example
In this example, the request pushes the CUSTOM_ANNOTATION event, which applies to all custom devices with the Coffee-2nd-floor tag. This annotation is a notification that these coffee machines are broken.
The API token is passed in the Authorization header.
Curl
curl -X POST \https://mySampleEnv.live.dynatrace.com/api/v1/events \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \-H 'Content-Type: application/json' \-d '{"eventType": "CUSTOM_ANNOTATION","timeoutMinutes": 0,"attachRules": {"tagRule": [{"meTypes": ["CUSTOM_DEVICE"],"tags": [{"context": "CONTEXTLESS","key": "IG-test"}]}]},"source": "OpsControl","annotationType": "defect","annotationDescription": "coffee machine is defective"}'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/events
Request body
{"eventType": "CUSTOM_ANNOTATION","timeoutMinutes": 0,"attachRules": {"tagRule": [{"meTypes": ["CUSTOM_DEVICE"],"tags": [{"context": "CONTEXTLESS","key": "IG-test"}]}]},"source": "OpsControl","annotationType": "defect","annotationDescription": "coffee machine is defective"}
Response body
{"storedEventIds": [-6153476110846051426],"storedIds": ["-6153476110846051426_1533300519291"],"storedCorrelationIds": []}
Response code
200