v1

latestOpenAPI 3.0.12026-07-233010767.7 KB
Incidents

Get incidents.

get/incidents

Query parameters

start-indexinteger

an integer specifying the starting point (beginning with 0) when paging through a list of entities

max-resultsinteger

the maximum number of results when paging through a list of incidents. (Note: when using ?include maximum is reduced to 25)

includestring[]

Describes optional properties that should be included in the response. You may declare multiple. (subscribed)

statesstring[]

state of the alert

servicesinteger[]

service IDs of the incident's affected services

fromstring date-time

from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime

untilstring date-time

until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime

Response

The incidents

idnumber
summarystring
status'INVESTIGATING' | 'IDENTIFIED' | 'MONITORING' | 'RESOLVED'

the incident status

messagestring
sendNotificationboolean
createdAtstring date-time
updatedAtstring date-time
resolvedOnstring date-time
subscribedboolean