Incidentary Docs

Incidents

Manage incident records via the Incidentary REST API

Incidents

Incidents are the top-level resource in Incidentary. An incident is created when an alert fires and is linked to the causal trace captured during the pre-arm window.

List Incidents

GET /v1/incidents

Query Parameters:

ParamTypeDescription
statusopen | resolved | allFilter by status. Default: all
servicestringFilter by service name
fromISO 8601Start of time range
toISO 8601End of time range
cursorstringPagination cursor
limitintegerResults per page (max 100, default 20)

Response:

{
  "data": [
    {
      "id": "inc_01HXYZ",
      "status": "open",
      "service": "order-service",
      "title": "High error rate on /checkout",
      "severity": "critical",
      "startedAt": "2026-03-01T02:14:00Z",
      "resolvedAt": null,
      "traceId": "trc_01HABC"
    }
  ],
  "pagination": { "cursor": "cur_01HXZ0", "hasMore": true }
}

Get Incident

GET /v1/incidents/:id

Response:

{
  "id": "inc_01HXYZ",
  "status": "open",
  "service": "order-service",
  "title": "High error rate on /checkout",
  "severity": "critical",
  "startedAt": "2026-03-01T02:14:00Z",
  "resolvedAt": null,
  "traceId": "trc_01HABC",
  "annotations": [],
  "tags": { "env": "production", "region": "us-east-1" }
}

Resolve Incident

PATCH /v1/incidents/:id
{
  "status": "resolved",
  "resolvedAt": "2026-03-01T02:45:00Z",
  "resolution": "Rolled back deploy abc123"
}

Create Incident (Manual)

POST /v1/incidents
{
  "service": "payment-service",
  "title": "Manual: elevated latency",
  "severity": "warning",
  "traceId": "trc_01HABC"
}

Manual incidents can be linked to an existing trace by passing traceId.

On this page