Status/API reference

Developer reference / 03

Status, in data.

Use the public JSON response to read the same service conditions and recorded checks shown on this page.

Endpoint

GET /api/status

Public read-only JSON · 30-second cache with stale-while-revalidate

Open raw JSON ↗

Response guide

What the response contains

Fields are generated from live reporting sources. Optional telemetry can be absent when its source cannot be read.

overallState

Current aggregate service condition.

headline / description

Plain-language summary of the current condition.

generatedAt / isStale

Response timestamp and freshness signal.

services

Public capabilities, their current states, and available probe details.

serviceHistories

Ninety daily marks per service with actual recorded check counts.

activeIncidents / activeMaintenance

Published current events and planned windows.

databaseHeartbeat

Direct database status and scheduled heartbeat details, when available.

When reporting cannot be confirmed

The API may return an error response with an unknown condition and a stale flag. Consumers should surface that uncertainty instead of displaying a healthy state.