Incidents - Developers

Notes

Expert level

The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.

List

API endpoint:

GET

https://stat2.io/api/v1/incidents

Request example:

curl --location --request GET 'https://stat2.io/api/v1/incidents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameter

Type

Description

search

optional string

The search query.

search_by

optional string

Search by. Possible values are: monitor for Monitor, cause for Cause. Defaults to: url.

monitor_id

optional string

Monitor ID.

status

optional string

Status. Possible values are: unresolved for Unresolved, acknowledged for Acknowledged, resolved for Resolved.

sort_by

optional string

Sort by. Possible values are: started_at for Date started, ended_at for Date ended. Defaults to: ended_at.

sort

optional string

Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.

per_page

optional integer

Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.

Show

API endpoint:

GET

https://stat2.io/api/v1/incidents/{id}

Request example:

curl --location --request GET 'https://stat2.io/api/v1/incidents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Update

API endpoint:

PUT PATCH

https://stat2.io/api/v1/incidents/{id}

Request example:

curl --location --request PUT 'https://stat2.io/api/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'

Parameter

Type

Description

comment

optional string

Comment.

acknowledged_at

optional boolean

Acknowledge.

ended_at

optional boolean

Resolve.

Delete

API endpoint:

DELETE

https://stat2.io/api/v1/incidents/{id}

Request example:

curl --location --request DELETE 'https://stat2.io/api/v1/incidents/{id}' \
--header 'Authorization: Bearer {api_key}'