v1
latestOpenAPI 3.0.12026-07-233010767.7 KBAlerts
List alerts (optionally matching certain criteria that are specified by query parameters).
Sample URLs
- List only alerts that are either in state PENDING or ACCEPTED: <br /> https://api.ilert.com/api/alerts?states=PENDING&states=ACCEPTED
- List only alerts that belong to the alert source with ID 1243 or 1743 and where user jd is a responder: <br /> https://api.ilert.com/api/alerts?sources=1243&sources=1743&responders=jd
- Paginate first batch for a range of alerts (note: query parameters should be url encoded): <br /> https://api.ilert.com/api/alerts?start-index=0&max-results=100&from=2021-03-01T21:24:56.771Z&until=2021-04-01T21:24:56.771Z
- Fetch next page, assuming equal to max-results were returned: <br/> https://api.ilert.com/api/alerts?start-index=100&max-results=100&from=2021-03-01T21:24:56.771Z&until=2021-04-01T21:24:56.771Z
- Pagination should be done based on the reportTime field using the parameters from and until as well as start-index. When building a local alert state store the id field should be used as identifier. The alertKey field is not suitable for this, as it is used to group related alerts to each other.
get/alerts
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 entities.
includestring[]
Describes optional properties that should be included in the response. You may declare multiple. (nextEscalationUser)
statesstring[]
state of the alert
sourcesinteger[]
alert source IDs of the alert's alert source
policiesinteger[]
escalation policy IDs of the alert's escalation policy
respondersstring[]
user ids of the user that is a responder of the alert
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
OK