Incidents API

Endpoints for managing incidents.

List Incidents

GET /api/v1/incidents

Query Parameters

Parameter	Description
`statusPageId`	Filter by status page
`status`	Filter by status
`limit`	Number of results

Response

{
  "data": [
    {
      "id": 1,
      "title": "API Performance Issues",
      "status": "investigating",
      "impact": "minor",
      "statusPageId": 1,
      "createdAt": "2024-01-15T10:30:00Z",
      "resolvedAt": null,
      "updates": [...],
      "affectedComponents": [...]
    }
  ]
}

Get Incident

GET /api/v1/incidents/:id

Create Incident

POST /api/v1/incidents

Request Body

{
  "title": "New Incident",
  "status": "investigating",
  "impact": "minor",
  "statusPageId": 1,
  "message": "Initial update message",
  "componentIds": [1, 2]
}

Valid Statuses

investigating
identified
monitoring
resolved

Valid Impacts

none
minor
major
critical

Update Incident

PATCH /api/v1/incidents/:id

Request Body

{
  "status": "identified",
  "impact": "major"
}

Add Incident Update

POST /api/v1/incidents/:id/updates

Request Body

{
  "message": "We have identified the root cause.",
  "status": "identified"
}

Resolve Incident

POST /api/v1/incidents/:id/resolve

Request Body

{
  "message": "The issue has been resolved."
}

Delete Incident

DELETE /api/v1/incidents/:id