API reference

The API is a JSON over HTTPS interface to everything on your page. The base URL is https://api.servicestatusdashboard.com/v1. Requests and responses use UTF-8 and ISO 8601 timestamps in UTC.

Authentication

Reading the status of a public page needs no key. Everything else needs a bearer token, created in the dashboard under Settings, API keys. Keys are scoped to one page.

# every request that changes data
Authorization: Bearer ssd_live_xxxxxxxxxxxxxxxx

Page status

The overall state of a page, computed from its components. This is what the banner at the top of a status page shows.

GET/v1/status
curl https://api.servicestatusdashboard.com/v1/status

{
  "status": "operational",
  "page": "servicestatusdashboard",
  "updated_at": "2026-11-18T09:41:07Z"
}

Possible values of status: operational, degraded, partial_outage, major_outage, maintenance.

Components

Components are the rows on your page. Each one has its own state and 90 days of history.

GET/v1/components
{
  "components": [
    { "id": "api", "name": "Public API", "status": "operational" },
    { "id": "pages", "name": "Status pages", "status": "operational" }
  ]
}

Incidents

Create an incident, then post updates to it. Each update is sent to subscribers of the affected components.

POST/v1/incidents
FieldTypeDescription
titlestringShort summary shown on the page and in notifications.
impactstringdegraded, partial_outage or major_outage.
componentsarrayIDs of the affected components.
messagestringThe first update. Markdown is supported.
notifybooleanSend to subscribers. Defaults to true.

Errors

Errors use standard HTTP status codes and a JSON body with a machine-readable error field.

HTTP/1.1 401 Unauthorized

{
  "error": "unauthorized",
  "message": "Missing or invalid bearer token."
}