Skip to main content
Every console action on incidents has an API equivalent. You can wire alerting (PagerDuty, Opsgenie) or ChatOps (Slack slash commands, GitHub Actions) to file and update incidents directly.

Auth

API keys are issued per organisation. Four scopes cover incidents and maintenance:
  • read:incidents and write:incidents: list and retrieve; create, patch, publish, resolve, delete.
  • read:maintenances and write:maintenances: list and retrieve; create, patch, start, complete, cancel.
Grant read:incidents / write:incidents and read:maintenances / write:maintenances as needed; write scopes do not include read.

File a new incident from a Slack slash command

The response includes id, the projected lifecycle state, and the affected-service rollup. Use the id for follow-up calls.

Append a status update

A Resolved message auto-marks the parent incident resolved.

Resolve

Schedule a maintenance window

Idempotency

The from-metric endpoint is dedupe-protected:
Returns the existing unpublished draft with the same title created in the last 30 minutes or, failing that, an unresolved incident affecting any of the metric’s services created in the last 60 minutes. Useful when an alert hook may fire duplicate webhooks.
Lifecycle referenceEvery endpoint above corresponds to a documented state transition. See Incident lifecycle reference for the full state machine.