Ops platform / HTTP API
Status and health
The public status of the platform and its health probes.
The public status of the platform and its health probes.
GET /api/v1/status/public
The public status document behind status.syncronet.dev, deliberately unauthenticated and deliberately shallow: states and timestamps, nothing about how we know them.
| Status | Means | Body |
|---|---|---|
| 200 | Done | PublicStatusResponse |
GET /health
Liveness probe.
| Status | Means | Body |
|---|---|---|
| 200 | Service is up |
GET /readyz
Ready to serve: answers 200 when ops can do its work.
| Status | Means | Body |
|---|---|---|
| 200 | Done | |
| 503 | Not ready |
Types
PublicStatusResponse
| Field | Type | About |
|---|---|---|
components | array of PublicComponent | |
generated_at | string | |
incidents | array of PublicIncident | Incident-ish entries folded from the last ~30 days of transitions. |
state | string | Worst component state: operational | degraded | down. |
PublicComponent
| Field | Type | About |
|---|---|---|
name | string | |
since | string | |
slug | string | |
state | string | operational | degraded | down |
PublicIncident
| Field | Type | About |
|---|---|---|
name | string | |
resolved_at (optional) | string or null | null while the incident is still ongoing. |
slug | string | |
started_at | string | |
state | string | The worst state reached during the incident. |