Service endpoints

The routes that report whether the service is up, and the routes that are not part of the customer API.

Health and readiness #

GET /health returns a fixed body:

{"status":"ok"}

GET /ready returns 200 when the server can take sessions and 503 when it cannot, with ready and reason in the JSON body. Both are unauthenticated. Every other route needs a key (Authentication).

Operator routes #

/metrics, /v1/metadata and /v1/admin/drain are for the people running the service and need the admin scope; they are not part of the customer API. A drain reaches your client as drain.notice, described on Streaming.

Interactive documentation is not served #

/docs, /redoc, /openapi.json and /docs/oauth2-redirect are deliberately not served and return 404. These pages are the reference.