Sign in
metadata

Check HTTP Server Status

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

Response

Ory Oathkeeper is ready to accept connections.

statusstring required

Always "ok".

Changes

Changed in 3 of the 40 revisions of this API.110

  • ac46e67380471See the full diff
    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

  • 4a4308530ea15See the full diff
    • ○

      api operation id isInstanceAlive removed and replaced with isAlive

      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 500

      response-media-type-added

  • 26e7abf193b014See the full diff
    • ▲

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

      response-media-type-removed

    • ○

      api operation id isAlive removed and replaced with isInstanceAlive

      api-operation-id-removed

    • ○

      api tag api added

      api-tag-added

    • ○

      api tag metadata removed

      api-tag-removed

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

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