Create incidents
Post to POST /api/incidents with the following payload:
{
"title": "Payments service latency",
"severity": "P2",
"services": ["payments"],
"description": "API latency exceeds SLA",
"reported_by": "[email protected]"
}
The response returns an incident_id you can use to update status or notify other systems.
Update severity & status
Patch /api/incidents/{incident_id} to change severity, status, or add comments. Include:
severity(P1|P2|P3)status(investigating|mitigated|monitoring|resolved)notesfor timeline context.
Request examples
Use API keys scoped to incident management (create, update, read). Rotate keys regularly and keep them in a secrets manager.
- Webhook integration: Send incidents from external alerting tools.
- Automation scripts: Create incidents from CI/CD runners when deployments fail.
Vision
The Incident API is an early-stage design. Upcoming ideas include:
- Webhook subscriptions for status changes.
- Bulk incident creation for outage windows.
- Cross-account incident sync via federated API keys.