Sign in
Health & Monitoring

Liveness + readiness probe

Returns 200 when healthy, 503 when any mandatory dependency (storage, scheduler, message bus, grpc) is degraded. The body carries per-component status so orchestrators can show which specific thing is broken.

get/health

Response

Healthy

status'healthy' | 'degraded' required
checksobject required

Per-component status — "ok" or "error: <reason>".

timestampstring date-time required

Changes

Changed in 3 of the 12 revisions of this API.169

  • 8a22dc180044144See the full diff
    • ▲

      removed the required property ready from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property uptime_seconds from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property version from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new degraded enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new healthy enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ○

      api operation id healthCheck removed and replaced with

      api-operation-id-removed

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the required property checks to the response with the 200 status

      response-required-property-added

    • ○

      added the required property timestamp to the response with the 200 status

      response-required-property-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 970d68a5c55d24See the full diff
    • ●

      removed the optional property timestamp from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property uptime from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property uptime_seconds to the response with the 200 status

      response-optional-property-added

    • ○

      removed the degraded enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the healthy enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the unhealthy enum value from the status response property for the response status 200

      response-property-enum-value-removed

  • 975e49e9b6751See the full diff
    • ○

      endpoint added

      endpoint-added