Browse docs
On this page

Public Status API

Each public status page exposes a JSON endpoint for automation and external integrations.

Endpoint

GET /api/status on the status-page domain for a specific slug.

Example:

https://your-slug.<status-domain>/api/status

Response Shape

The response includes:

  • overall_status
  • groups[] with nested components[]
  • ungrouped_components[]
  • updated_at

Example Fields

{
  "overall_status": "operational",
  "groups": [
    {
      "id": "...",
      "name": "Core API",
      "components": [
        {
          "id": "...",
          "name": "Auth Service",
          "status": "operational"
        }
      ]
    }
  ],
  "ungrouped_components": [],
  "updated_at": "2026-01-10T18:20:00+00:00"
}

Notes

  • Endpoint only resolves for public status pages.
  • Unknown/non-public slugs return 404.

Related