Skip to navigation

Health check

View as Markdown

Check whether the public API is ready to receive traffic. No authentication is required.

Returns 200 with status: ok when ready, or 503 with status: degraded when it is not ready.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Service is healthy
statusenum
Allowed values:

Errors

406
Not Acceptable Error
503
Service Unavailable Error