Skip to main content

Incidents API

Incidents group related alerts into a single manageable unit. Use this API to list, acknowledge, and resolve incidents.

List Incidents

GET /api/v1/incidents
Query Parameters
ParameterTypeDescription
statusstringFilter by status: triggered, acknowledged, resolved
severitystringFilter by severity: info, warning, critical
limitintegerMaximum results (default: 50, max: 100)
Response
{
  "data": [
    {
      "id": "inc_1234567890",
      "title": "High Error Rate on API Gateway",
      "status": "triggered",
      "severity": "critical",
      "alert_count": 3,
      "triggered_at": "2024-01-15T10:30:00Z",
      "acknowledged_at": null,
      "resolved_at": null,
      "affected_services": ["api-gateway", "auth-service"]
    }
  ],
  "meta": {
    "total": 12,
    "limit": 50
  }
}

Get Incident

GET /api/v1/incidents/:id
Response
{
  "data": {
    "id": "inc_1234567890",
    "title": "High Error Rate on API Gateway",
    "summary": "Error rate exceeded threshold of 5% for more than 5 minutes",
    "status": "acknowledged",
    "severity": "critical",
    "triggered_at": "2024-01-15T10:30:00Z",
    "acknowledged_at": "2024-01-15T10:32:00Z",
    "acknowledged_by": "[email protected]",
    "resolved_at": null,
    "affected_services": ["api-gateway", "auth-service"],
    "alerts": [
      {
        "id": "alert_001",
        "name": "Error Rate High",
        "state": "firing",
        "current_value": 8.5
      }
    ],
    "timeline": [
      {
        "event": "triggered",
        "timestamp": "2024-01-15T10:30:00Z"
      },
      {
        "event": "acknowledged",
        "timestamp": "2024-01-15T10:32:00Z",
        "by": "[email protected]"
      }
    ]
  }
}

Acknowledge Incident

Mark an incident as acknowledged to indicate someone is working on it.
POST /api/v1/incidents/:id/acknowledge
Request
{
  "by": "[email protected]",
  "note": "Investigating the root cause"
}
Response
{
  "data": {
    "id": "inc_1234567890",
    "status": "acknowledged",
    "acknowledged_at": "2024-01-15T10:32:00Z",
    "acknowledged_by": "[email protected]"
  }
}

Resolve Incident

Mark an incident as resolved.
POST /api/v1/incidents/:id/resolve
Request
{
  "by": "[email protected]",
  "note": "Root cause was a misconfigured load balancer. Fixed and deployed."
}
Response
{
  "data": {
    "id": "inc_1234567890",
    "status": "resolved",
    "resolved_at": "2024-01-15T11:00:00Z",
    "resolved_by": "[email protected]",
    "resolution_note": "Root cause was a misconfigured load balancer. Fixed and deployed."
  }
}

Incident Timeline

The timeline tracks all events during an incident’s lifecycle:
EventDescription
triggeredIncident was created
acknowledgedSomeone acknowledged the incident
alert_addedNew alert was grouped into incident
escalatedEscalation policy advanced to next step
notification_sentNotification was delivered
resolvedIncident was marked resolved