ORory
metadata

Check HTTP Server and Database Status

Changed on

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

Request

  • The document declares no server URL.
  • Auth
    none declared

Response

Ory Oathkeeper is ready to accept requests.

statusstring required

Always "ok".

Changes

  • 4a4308530ea1Revision changes
    • info

      api operation id isInstanceReady removed and replaced with isReady

    • info

      api tag metadata added

    • info

      api tag api removed

    • info

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

    • info

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

  • 26e7abf193b0Revision changes
    • breaking

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

    • breaking

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

    • info

      api operation id isReady removed and replaced with isInstanceReady

    • info

      api tag api added

    • info

      api tag metadata removed