System Health
Detailed service health snapshots for the running deployment. Where Server Heartbeat only tells you the API is reachable, these endpoints give you the internal picture — per-service status, last-checked timestamps, and any error states.
Scopes
| Scope | Reach |
|---|---|
admin | Reading all service health snapshots. |
Endpoints
Get All Service Health Snapshots
GET /api/admin/health/
Returns a snapshot for every monitored service (database, queue, mail, storage, etc.).
Required scope: admin · also accepts API key
Response 200 — map of service name → snapshot.
Get Service Health Snapshot
GET /api/admin/health/{full_service_name}
Returns the detailed health snapshot for a single service.
Required scope: admin · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
full_service_name | string | yes | Fully qualified service name (see Get All Service Health Snapshots for valid values). |
Response 200 — HealthSnapshotRead
See also
- Server Heartbeat — unauthenticated liveness probe.
- Logging › System Logs — long-form logs for diagnosing health issues.