Handbook
Examples — Telemetry + host health
Sample curl + jq filters live in Examples & recipes.
Updated
| Goal | Endpoint |
|---|---|
| Tiny heartbeat JSON | GET /v1/health |
| Buffered telemetry waveforms | GET /v1/telemetry?minutes=… |
| Operator bundles | GET /v1/admin/snapshot |
| Cooldown accounting | GET /v1/cooldown-summary |
Sample curl + jq filters live in Examples & recipes.
Purpose
Map observability endpoints (health, telemetry, snapshot, cooldown-summary) to outcomes.
Prerequisites
Bearer auth when required; understand period query params for time windows.
Copy-paste steps
Reuse filters from Examples & recipes for curl + jq.
Expected output
GET /v1/telemetry returns samples arrays per telemetry-response.schema.json subset; /v1/health matches health-response.schema.json.
Error handling
400 when period is missing/invalid—response JSON lists allowed periods.
Security notes
/v1/admin/snapshot is operator-grade; protect bearer tokens accordingly.
Related
telemetry-response.schema.json·health-response.schema.json·cooldown-summary-response.schema.json- HTTP API
Validation status
- Fixture
payloads/valid/health-response.jsonvalidates againsthealth-response.schema.jsonin CI. - OpenAPI refs:
TelemetryResponse,AdminSnapshotResponsein../schemas/openapi.json.