API Reference

Incidents

Track active and resolved upstream incidents

GET/incidents

API token

List active incidents

Returns all active (unresolved) incidents affecting services your organization depends on.

Responses

dataIncident[]Required

Example Response

JSON

{
  "data": [
    {
      "id": "inc_789",
      "title": "Elevated API error rates",
      "impact": "minor",
      "status": "investigating",
      "startedAt": "2026-03-12T08:45:00.000Z",
      "service": {
        "id": "svc_stripe",
        "name": "Stripe",
        "slug": "stripe"
      }
    }
  ]
}

Code Samples

Code

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://checkupstream.com/api/v1/incidents

GET/incidents/{id}

API token

Get incident detail

Returns an incident with its full timeline of status updates. Use this to understand the progression and resolution of an upstream issue.

Parameters

idstringpathrequired

Incident ID

Responses

dataIncidentDetailRequired

Example Response

JSON

{
  "data": {
    "id": "inc_789",
    "title": "Elevated API error rates",
    "impact": "minor",
    "status": "monitoring",
    "startedAt": "2026-03-12T08:45:00.000Z",
    "resolvedAt": null,
    "statusPageUrl": "https://status.stripe.com/incidents/abc123",
    "service": {
      "id": "svc_stripe",
      "name": "Stripe",
      "slug": "stripe"
    },
    "updates": [
      {
        "id": "upd_001",
        "status": "investigating",
        "body": "We are investigating elevated error rates on the Charges API.",
        "createdAt": "2026-03-12T08:45:00.000Z"
      },
      {
        "id": "upd_002",
        "status": "monitoring",
        "body": "A fix has been deployed. We are monitoring for recovery.",
        "createdAt": "2026-03-12T09:10:00.000Z"
      }
    ]
  }
}

Code Samples

Code

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://checkupstream.com/api/v1/incidents/inc_789

Create an API token

Use a read-scoped API token for organization data in scripts and backend services.

Manage API tokens Credential guide