Sign in
metadata

Check HTTP Server and Database Status

This endpoint returns a HTTP 200 status code when Ory Oathkeeper is up running and the environment dependencies (e.g. the database) are responsive as well.

If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set.

Be aware that if you are running multiple nodes of Ory Oathkeeper, the health status will never refer to the cluster state, only to a single instance.

get/health/ready

Response

Ory Oathkeeper is ready to accept requests.

statusstring required

Always "ok".

Changes

Changed in 2 of the 40 revisions of this API.28

  • 4a4308530ea15See the full diff
    • ○

      api operation id isInstanceReady removed and replaced with isReady

      api-operation-id-removed

    • ○

      api tag metadata added

      api-tag-added

    • ○

      api tag api removed

      api-tag-removed

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 503

      response-media-type-added

  • 26e7abf193b023See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 503

      response-media-type-removed

    • ○

      api operation id isReady removed and replaced with isInstanceReady

      api-operation-id-removed

    • ○

      api tag api added

      api-tag-added

    • ○

      api tag metadata removed

      api-tag-removed

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