API reference
Telemetry API
- Status live
- Base URL
https://api.sasek.org/telemetry - Endpoints 3
A public, read-only snapshot of the home server's health.
Telemetry serves the latest health sample of the home server. It is public and read-only, so no token is needed. Responses name the host's services but include no hostnames or IP addresses. Limits: each client address gets 60 requests a minute. A limited request gets 429 with a Retry-After header in seconds. Other paths, and methods other than GET, get 404 with code not_found. OPTIONS answers 204 for CORS preflight. Browsers: responses carry Access-Control-Allow-Origin: https://sasek.org. A browser on any other origin cannot read them. Other clients are not affected. Caching: a sample is served with Cache-Control: public, max-age=5. The health route is never cached.
Auth. None. Each operation says whether it needs a token.
Health
| Method | Endpoint | What it does |
|---|---|---|
| GET | /v1/summary | The latest snapshot |
| GET | /v1/uptime | Uptime for each service, by day |
| GET | /v1/health | Is the latest sample fresh? |
Schemas
Summary
| Field | Type | Required | Description |
|---|---|---|---|
version | integer | required | |
collected_at | string (date-time) | required | When the sample was taken, in UTC. |
containers | object | required | Every container Docker lists on the server, including helpers that are not services. |
services | object[] | optional | Our services, in the order the status page shows them. Each one's dependencies are nested under it. |
cpu | object | required | |
memory | object | required | |
disk | object | required |
Uptime
| Field | Type | Required | Description |
|---|---|---|---|
version | integer | required | |
window_days | integer | required | |
services | object[] | required | Our services, in the order the status page shows them. |
Health
| Field | Type | Required | Description |
|---|---|---|---|
healthy | boolean | required | |
collected_at | string or null (date-time) | required | When the newest sample was taken, or null before the first one. |
NotReady
| Field | Type | Required | Description |
|---|---|---|---|
error | string | required | |
code | string | required |
Error
| Field | Type | Required | Description |
|---|---|---|---|
error | string | required | |
code | string | required |