Skip to main content
GET
/
incidents
List incidents
curl --request GET \
  --url https://api.example.com/incidents \
  --header 'Authorization: Bearer <token>'
{
  "incidents": [
    {
      "id": "<string>",
      "monitor_id": "<string>",
      "metric_id": "<string>",
      "project_id": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123,
  "has_more": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

project_id
string<uuid>
required

Project whose incidents to list.

metric_id
string<uuid> | null

If set, only incidents for this metric.

monitor_id
string<uuid> | null

If set, only incidents raised by this monitor.

status
string | null

If set, filter by incident status (e.g. open or resolved).

limit
integer
default:50

Page size.

Required range: 1 <= x <= 200
offset
integer
default:0

Pagination offset.

Required range: x >= 0

Response

Successful Response

incidents
IncidentRead · object[]
required
total
integer
required
limit
integer
required
offset
integer
required
has_more
boolean
required