Skip to main content
GET
Health
Health endpoints do not require credentials or an api-version parameter. They return direct JSON objects rather than a success/data wrapper.

Liveness

HTTP 200 indicates that the API process is responding.

Readiness

Readiness summarizes service status without secret values. Inspect the response status as well as the HTTP code. Examples below show only the status fields; responses may contain additional diagnostic information.
A ready response does not grant permissions, enable public writes, or prove that an end-to-end portfolio workflow has completed successfully.

Compatibility

Existing clients may use /api/v1/health/live and /api/v1/health/ready. The older /api/v1/health diagnostic endpoint has a different response format; use liveness and readiness for new integrations.