Status API

Drive your status page from monitoring tools or scripts: flip a component's live status, open an incident, post updates, or pull the public snapshot.

Note:
The current public name for a component is "service": /status/services is the primary path. /status/components is a byte-identical legacy alias kept for existing consumers.

Components (services)

PATCH accepts metadata fields (name, description, groupId, showUptime, segmentIds) and/or status in the same call. A { "status": "..." }-only body is the primary automation hook for monitoring tools like Datadog or Pingdom.

curl -X PATCH https://your-domain/api/v1/status/services/status_component_01h4... \
  -H "Authorization: Bearer qb_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "status": "degraded_performance" }'

Incidents and maintenance

kind is incident or maintenance. Creating a maintenance window accepts scheduledStartAt/scheduledEndAt and autoStart/autoComplete to run it unattended. Posting a terminal update (resolved/completed) restores affected components to operational, unless skipRestore is set.

curl -X POST https://your-domain/api/v1/status/incidents \
  -H "Authorization: Bearer qb_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "incident",
    "title": "Elevated API error rates",
    "status": "investigating",
    "affectedComponents": [{ "componentId": "status_component_01h4...", "componentStatus": "partial_outage" }],
    "body": "We are investigating elevated error rates on the API."
  }'

Public summary

GET /api/v1/status/summary

Returns the same snapshot the public status page renders: overall status, every visible component, and active incidents. Requires a valid API key but no specific permission.

curl https://your-domain/api/v1/status/summary \
  -H "Authorization: Bearer qb_your_api_key"

{
  "data": {
    "status": "operational",
    "components": [
      { "id": "status_component_01h4...", "name": "API", "description": null, "status": "operational", "showUptime": true }
    ],
    "activeIncidents": []
  }
}

Next steps

• API Overview: Authentication, pagination, and errors
• Health endpoints: Liveness and readiness probes for self-hosting