Incidents

Incidents track service disruptions and communicate status to users.

List Incidents

GET/api/v1/incidentsFree

Returns all incidents for your organization, including updates and affected monitors.

curl https://unstatus.app/api/v1/incidents \
  -H "Authorization: Bearer usk_your_key"

Get Incident

GET/api/v1/incidents/:idFree

Returns an incident with its full update timeline and affected monitors.

Response

{
  "data": {
    "id": "inc_...",
    "title": "API degraded performance",
    "status": "investigating",
    "severity": "major",
    "startedAt": "2025-01-15T10:00:00Z",
    "resolvedAt": null,
    "updates": [
      {
        "id": "upd_...",
        "status": "investigating",
        "message": "We are investigating elevated error rates.",
        "createdAt": "2025-01-15T10:00:00Z"
      }
    ],
    "monitors": [
      { "monitor": { "id": "clx1abc...", "name": "API Server" } }
    ]
  }
}

Create Incident

POST/api/v1/incidentsAuthenticated

Creates an incident affecting one or more monitors. Sends notifications automatically.

Request body:

Field	Type	Required	Description
`monitorIds`	string[]	Yes	Monitor IDs affected
`title`	string	Yes	Incident title
`message`	string	Yes	Initial status update message
`status`	string	No	`investigating`, `identified`, `monitoring`, `resolved` (default `investigating`)
`severity`	string	No	`minor`, `major`, `critical` (default `minor`)

curl -X POST https://unstatus.app/api/v1/incidents \
  -H "Authorization: Bearer usk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "monitorIds": ["clx1abc..."],
    "title": "API degraded performance",
    "message": "We are investigating elevated error rates.",
    "severity": "major"
  }'

Update Incident

PATCH/api/v1/incidents/:idAuthenticated

Posts a status update to an incident. Setting status to resolved auto-sets resolvedAt.

Request body:

Field	Type	Required	Description
`status`	string	Yes	`investigating`, `identified`, `monitoring`, `resolved`
`message`	string	Yes	Update message

curl -X PATCH https://unstatus.app/api/v1/incidents/inc_... \
  -H "Authorization: Bearer usk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "resolved",
    "message": "The root cause was identified and fixed. All systems are back to normal."
  }'

Delete Incident

DELETE/api/v1/incidents/:idAuthenticated

Permanently deletes an incident and all its updates.

curl -X DELETE https://unstatus.app/api/v1/incidents/inc_... \
  -H "Authorization: Bearer usk_your_key"

List Incidents

Get Incident

Create Incident

Update Incident

Delete Incident

On this page