Skip to main content

Incidents API

Manage incidents, post updates to the incident timeline, and schedule maintenance windows.

Base URL: https://app.kamustatus.com/api

List Incidents

curl https://app.kamustatus.com/api/incidents \
-H "x-api-key: km_your_api_key"

Get Incident

curl https://app.kamustatus.com/api/incidents/:incidentId \
-H "x-api-key: km_your_api_key"

Response:

{
"id": "inc_001",
"title": "API degraded performance",
"status": "identified",
"monitorIds": ["mon_abc123"],
"startedAt": "2025-05-15T08:30:00Z",
"resolvedAt": null,
"updates": [
{
"id": "upd_001",
"status": "investigating",
"message": "We are investigating elevated error rates.",
"createdAt": "2025-05-15T08:30:00Z"
},
{
"id": "upd_002",
"status": "identified",
"message": "Root cause identified as a database connection pool issue.",
"createdAt": "2025-05-15T08:45:00Z"
}
]
}

Create Incident

curl -X POST https://app.kamustatus.com/api/incidents \
-H "x-api-key: km_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"title": "Scheduled database migration",
"status": "investigating",
"message": "We are performing a planned database migration.",
"monitorIds": ["mon_abc123"]
}'

Update Incident

curl -X PATCH https://app.kamustatus.com/api/incidents/:incidentId \
-H "x-api-key: km_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"status": "resolved",
"message": "The issue has been resolved. All services are operating normally."
}'

Each update to the incident status adds an entry to the updates timeline.

Delete Incident

curl -X DELETE https://app.kamustatus.com/api/incidents/:incidentId \
-H "x-api-key: km_your_api_key"

Incident Statuses

StatusDescription
investigatingThe issue has been detected and is being looked into
identifiedThe root cause has been found
monitoringA fix has been applied and is being observed
resolvedThe incident is closed

Maintenance Windows

Schedule planned maintenance to suppress alerts during the window.

Create Maintenance Window

curl -X POST https://app.kamustatus.com/api/incidents \
-H "x-api-key: km_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"title": "Planned maintenance",
"status": "monitoring",
"message": "Scheduled maintenance window for infrastructure upgrade.",
"monitorIds": ["mon_abc123", "mon_def456"],
"maintenance": true,
"scheduledStart": "2025-06-01T02:00:00Z",
"scheduledEnd": "2025-06-01T04:00:00Z"
}'

During a maintenance window, alerts for the affected monitors are suppressed and the status page shows a maintenance banner.