Incidents API

Full CRUD access to your incidents. Requires an API key with the appropriate incidents:read or incidents:write scope.

List incidents

GET /user/api/v1/incidents

Required scope: incidents:read

Query parameters:

Example:

curl -H "Authorization: Bearer spk_..." \
  "https://statuspage.me/user/api/v1/incidents?status_page_id=550e8400-e29b-41d4-a716-446655440000"

Get a single incident

GET /user/api/v1/incidents/:id

Required scope: incidents:read

Returns the incident and its full update timeline.

Create an incident

POST /user/api/v1/incidents

Required scope: incidents:write

Request body:

{
  "title": "Database latency spike",
  "message": "We are investigating elevated response times.",
  "status_page_id": "550e8400-e29b-41d4-a716-446655440000",
  "component_id": "",
  "incident_state_id": "1",
  "notify_subscribers": true
}

Response: 201 Created with the created incident object.

Update an incident

PATCH /user/api/v1/incidents/:id

Required scope: incidents:write

Request body (all fields optional):

{
  "title": "Database latency — resolved",
  "message": "The issue has been resolved.",
  "incident_state_id": "4"
}

Add an incident update (timeline entry)

POST /user/api/v1/incidents/:id/updates

Required scope: incidents:write

Request body:

{
  "message": "We have identified the root cause and are applying a fix.",
  "incident_state_id": "2"
}

At least one of message or incident_state_id is required.

Delete an incident

DELETE /user/api/v1/incidents/:id

Required scope: incidents:write

Permanently deletes the incident and its updates.

Incident state IDs

The incident_state_id field typically maps to:

Exact IDs may vary — use the public status page or support docs to confirm your values.