API reference
Authentication, pagination, errors, rate limits, generated endpoint pages, and webhook and heartbeat URLs.
upzero's REST API is the same API the console and CLI use, at
<UPZERO_API_URL>/api/v1. Every request is authenticated and, except for a
handful of account-level routes, scoped to one organization.
Start with Authentication for how a request identifies its caller and its organization, then Pagination, Errors and Rate limits for conventions shared across every endpoint.
Endpoints is generated directly from the backend's own
OpenAPI document, one page per route group, and regenerates with make regenerate-docs-references whenever a route changes. Webhooks
and Heartbeat cover the two URL shapes that are
hand-written because they are not ordinary CRUD resources: an inbound push
URL, and (once it exists) outbound event delivery.
Authentication
Bearer tokens, service accounts and organization selection.
Pagination
Query parameters and response shape for list endpoints.
Errors
The response envelope and status codes.
Rate limits
Limits by endpoint type, headers, and what is on by default.
Endpoints
Every route, generated from the backend's OpenAPI document.
Webhooks
The current state of outbound webhook delivery.
Heartbeat
The push URL for passive monitors.