Events API - GET events feed
Lists all of your environment's events and their parameters. Because the possible number of events can be large, the response is limited to 150 events. You can narrow down the output by specifying filtering parameters in your request.
The request produces an application/json
payload.
GET |
|
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
from | integer |
Start timestamp of the query, in UTC milliseconds. If not set, 30 days ago from now is used, unless relativeTime is set. |
query | optional |
to | integer |
End timestamp of the query, in UTC milliseconds. If not set, the current timestamp is used, unless relativeTime is set. The timeframe must not exceed 2 years. |
query | optional |
relativeTime | string |
Relative timeframe, back from the current time. The relativeTime element can hold these values. |
query | optional |
eventType | string |
Filters the resulting set of events by the event type. The eventType element can hold these values. |
query | optional |
entityId | string |
Filters the resulting set of events to the events, related to the specified DESK entity. |
query | optional |
cursor | string |
The response is limited to 150 events, so if you want to receive more you can use the cursor to get the next 150. This parameter should be empty when querying for the first time. The cursor key can then be found in the nextCursor field of the previous response. When using the cursor string, it is not necessary to specify the additional parameters, as that info is already encoded within the cursor. |
query | optional |
Possible values
Possible values for the eventType element:
- APPLICATION_JS_FRAMEWORK_DETECTED
- AVAILABILITY_EVENT
- CONNECTION_LOST
- CPU_SATURATED
- CUSTOM_ALERT
- CUSTOM_ANNOTATION
- CUSTOM_APP_CRASH_RATE_INCREASED
- CUSTOM_CONFIGURATION
- CUSTOM_DEPLOYMENT
- CUSTOM_INFO
- DATABASE_CONNECTION_FAILURE
- DOCKER_MEMORY_SATURATION
- EBS_VOLUME_HIGH_LATENCY
- ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE
- ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE
- ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE
- ERROR_EVENT
- ESXI_START
- FAILURE_RATE_INCREASED
- HIGH_CONNECTIVITY_FAILURES
- HIGH_DROPPED_PACKETS_RATE
- HIGH_GC_ACTIVITY
- HIGH_LATENCY
- HIGH_NETWORK_ERROR_RATE
- HIGH_NETWORK_LOSS_RATE
- HIGH_NETWORK_UTILIZATION
- HOST_CONNECTION_FAILED
- HOST_CONNECTION_LOST
- HOST_DATASTORE_LOW_DISK_SPACE
- HOST_DISK_LOW_INODES
- HOST_GRACEFULLY_SHUTDOWN
- HOST_LOG_AVAILABILITY
- HOST_LOG_ERROR
- HOST_LOG_MATCHED
- HOST_LOG_PERFORMANCE
- HOST_MAINTENANCE
- HOST_NO_CONNECTION
- HOST_OF_SERVICE_UNAVAILABLE
- HOST_SHUTDOWN
- HOST_TIMEOUT
- HTTP_CHECK_GLOBAL_OUTAGE
- HTTP_CHECK_LOCAL_OUTAGE
- HTTP_CHECK_TEST_LOCATION_SLOWDOWN
- INSUFFICIENT_DISK_QUEUE_DEPTH
- JAVASCRIPT_ERROR_RATE_INCREASED
- LAMBDA_FUNCTION_HIGH_ERROR_RATE
- LOG_AVAILABILITY
- LOG_ERROR
- LOG_MATCHED
- LOG_PERFORMANCE
- LOW_DISK_SPACE
- LOW_STORAGE_SPACE
- MARKED_FOR_TERMINATION
- MEMORY_RESOURCES_EXHAUSTED
- MEMORY_SATURATED
- MOBILE_APP_CRASH_RATE_INCREASED
- MONITORING_UNAVAILABLE
- OPENSTACK_KEYSTONE_SLOW
- OPENSTACK_KEYSTONE_UNHEALTHY
- OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE
- OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE
- OVERLOADED_STORAGE
- PERFORMANCE_EVENT
- PGI_HAPROXY_QUEUED_REQUESTS_HIGH
- PGI_HAPROXY_SESSION_USAGE_HIGH
- PGI_MYSQL_SLOW_QUERIES_RATE_HIGH
- PGI_OF_SERVICE_UNAVAILABLE
- PGI_RMQ_HIGH_FILE_DESC_USAGE
- PGI_RMQ_HIGH_MEM_USAGE
- PGI_RMQ_HIGH_PROCESS_USAGE
- PGI_RMQ_HIGH_SOCKETS_USAGE
- PGI_RMQ_LOW_DISK_SPACE
- PROCESS_CRASHED
- PROCESS_CUSTOM_AVAILABILITY
- PROCESS_CUSTOM_ERROR
- PROCESS_CUSTOM_PERFORMANCE
- PROCESS_GROUP_LOW_INSTANCE_COUNT
- PROCESS_LOG_AVAILABILITY
- PROCESS_LOG_ERROR
- PROCESS_LOG_PERFORMANCE
- PROCESS_RESTART
- PROCESS_UNAVAILABLE
- RDS_OF_SERVICE_UNAVAILABLE
- RDS_RESTART_SEQUENCE
- RESOURCE_CONTENTION
- SERVICE_RESPONSE_TIME_DEGRADED
- SLOW_DISK
- SYNTHETIC_AVAILABILITY
- SYNTHETIC_SLOWDOWN
- THREADS_RESOURCES_EXHAUSTED
- UNEXPECTED_HIGH_LOAD
- UNEXPECTED_LOW_LOAD
- USER_ACTION_DURATION_DEGRADATION
- VIRTUAL_MACHINE_SHUTDOWN
- WEB_CHECK_GLOBAL_OUTAGE
- WEB_CHECK_LOCAL_OUTAGE
Possible values for the relativeTime element:
- 10mins
- 15mins
- 2hours
- 30mins
- 3days
- 5mins
- 6hours
- day
- hour
- min
- month
- week
Response format
Each event contains at least the following meta information elements and event-specific properties.
The EventQueryResult object
Events of the environment.
Element | Type | Description |
---|---|---|
nextEventStartTms | integer | The start time of the 151st event in the response. |
nextEventId | integer | ID of the next event if the total number of events exceeds the maximum batch size of 150 events per request. |
nextCursor | string | The cursor for the next 150 events, fitting the specified criteria. Set this value for the cursor query parameter. Without it you'll get the first 150 events again. You don't have to specify any additional parameters, because the cursor already contains all of them. |
from | integer | Start of the query timeframe. |
to | integer | End of the query timeframe. |
totalEventCount | integer | The total amount of events, fitting the specified criteria. |
events | EventRestEntry[] | The list of events. |
The EventRestEntry object
Set of parameters of the event.
Apart from the general properties mentioned here, which each event has, an actual event has a set of metadata that varies depending on the event type.
Element | Type | Description |
---|---|---|
eventId | integer | The ID of the event. This field is provided for compatibility reasons. You should use the id field instead. |
startTime | integer | The timestamp of the event detection, in UTC milliseconds. |
endTime | integer | The timestamp of the event closure, in UTC milliseconds |
entityId | string | The ID of the affected DESK entity. |
entityName | string | The name of the affected DESK entity. |
severityLevel | string | The severity of the event. |
impactLevel | string | The impact level of the event. It shows what is affected by the problem: infrastructure, service, or application. |
eventType | string | The type of the event. |
resourceId | string | The id of the resource the event occurred on. |
resourceName | string | The name of the resource the event occurred on. |
eventStatus | string | The state of the event: open or closed. |
tags | TagInfo[] | Tags of the DESK entity that raised the event. |
id | string | The encoded ID of the event. The format is eventID_startTime. You should use the value from this field when you need an event ID. |
The TagInfo object
Tag of a DESK entity.
Element | Type | Description |
---|---|---|
context | string | The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
key | string | The key of the tag. Custom tags have the tag value here. |
value | string | The value of the tag. Not applicable to custom tags. |
{
"nextEventStartTms": 1521042929000,
"nextEventId": 3019761712620558300,
"nextCursor": "AgEBAAFn5IIFrgEAAAFofwDTrgAAAQAcMTY4N2RhYzViZTAtZmUxODEwOWQ5YTA1MTIyNQ%3D%3D",
"from": 1521042929000,
"to": 1521542929000,
"totalEventCount": 2,
"events": [
{
"eventId": 5915682011263205000,
"startTime": 1521042929000,
"endTime": 1521542929000,
"entityId": "HOST-0000000000000007",
"entityName": "Example Host",
"severityLevel": "PERFORMANCE",
"impactLevel": "INFRASTRUCTURE",
"eventType": "SLOW_DISK",
"eventStatus": "OPEN",
"tags": [
{
"context": "CONTEXTLESS",
"key": "exampleTag"
}
],
"id": "5915682011263205071_1521042929000",
"source": "builtin"
},
{
"eventId": 5915682011263205000,
"startTime": 1521042929000,
"endTime": 1521542929000,
"entityId": "HOST-0000000000000007",
"entityName": "Example Host",
"severityLevel": "PERFORMANCE",
"impactLevel": "INFRASTRUCTURE",
"eventType": "SLOW_DISK",
"eventStatus": "OPEN",
"tags": [
{
"context": "CONTEXTLESS",
"key": "exampleTag"
}
],
"id": "5915682011263205071_1521042929000",
"source": "builtin"
}
]
}
Example
In this example, the request queries all the ERROR_EVENT events that occurred during the last 24 hours. The result is truncated to two events.
The API token is passed in the Authorization header.
Curl
curl -X GET \
'https://mySampleEnv.live.dexp.ae/api/v1/events?eventType=ERROR_EVENT&relativeTime=day' \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dexp.ae/api/v1/events?eventType=ERROR_EVENT&relativeTime=day
Response content
{
"nextEventStartTms": null,
"nextEventId": null,
"nextCursor": null,
"from": 1530703635653,
"to": 1533295635653,
"totalEventCount": 25,
"events": [
{
"eventId": -8338439733889003014,
"startTime": 1532328338475,
"endTime": 1532328638475,
"entityId": "HOST-E4D1E5F46E239F21",
"entityName": "l-8.dyna.trace",
"severityLevel": "ERROR",
"impactLevel": "INFRASTRUCTURE",
"eventType": "ERROR_EVENT",
"eventStatus": "CLOSED",
"tags": [
{
"context": "CONTEXTLESS",
"key": "deploy"
},
{
"context": "CONTEXTLESS",
"key": "room23"
}
],
"id": "-8338439733889003014_1532328338475",
"annotationDescription": "testTrigger",
"correlationId": "67da0a4293956e55",
"source": "restTest"
},
{
"eventId": 3092227520312561338,
"startTime": 1531832640600,
"endTime": 1531836240600,
"entityId": "HOST-CE6A2253598EA88D",
"entityName": "q2.docker.l5",
"severityLevel": "ERROR",
"impactLevel": "INFRASTRUCTURE",
"eventType": "ERROR_EVENT",
"eventStatus": "CLOSED",
"tags": [
{
"context": "CONTEXTLESS",
"key": "ServiceNow"
}
],
"id": "3092227520312561338_1531832640600",
"customProperties": {
"Property 2": "value 2",
"Property 1": "value 1",
"Property 3": "value 3"
},
"annotationDescription": "package is damaged",
"correlationId": "1b79973c6902b486",
"source": "myAPI"
}
]
}
Response code
200