ORory
metadata

Check HTTP Server Status

Changed on

This endpoint returns a HTTP 200 status code when Ory Oathkeeper is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working.

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 this service, the health status will never refer to the cluster state, only to a single instance.

get/health/alive

Request

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

Response

Ory Oathkeeper is ready to accept connections.

statusstring required

Always "ok".

Changes

  • ac46e6738047Revision changes
    • info

      removed the non-success response with the status

  • 4a4308530ea1Revision changes
    • info

      api operation id isInstanceAlive removed and replaced with isAlive

    • 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