ORory
health

Check readiness status

This endpoint returns a 200 status code when the HTTP server 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 this service, the health status will never refer to the cluster state, only to a single instance.

get/health/ready

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /health/ready
  • Auth
    none declared

Response

healthStatus

statusstring

Status always contains "ok".

Changes

No recorded changes to this operation across all 65 revisions of this API.