API Reference
REST API for managing projects, breakers, and metrics. All endpoints require authentication via API key or HMAC signature.
Resources
breaker metadata
Lightweight endpoints for reading and writing breaker metadata without touching full breaker configs.
breakers
Configure circuit breakers for a project. Breakers evaluate metric rules and trigger actions as they trip and recover.
events
List breaker state transition history.
metrics
Ingest metric samples for evaluation. Each sample targets a router via router_id. GZIP compression: Supported via Content-Encoding: gzip header. When using GZIP, compute the HMAC signature on the compressed (wire) bytes, not the uncompressed JSON. Flow: serialize JSON → gzip compress → compute HMAC on compressed bytes → send.
notification channels
Configure alert channels for trip/recover notifications.
projects
Manage projects and their settings.
router metadata
Lightweight endpoints for reading and writing router metadata without touching full router configs.
routers
Manage routers that map router_id samples to one or more breakers (fan-in/fan-out).
status
Get project health and breaker status.