v1

latestOpenAPI 3.0.0raw.githubusercontent.com2018-11-15474.9 KB
health

Check the 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.

This status does currently not include checks whether the database connection is working. This endpoint does not require the X-Forwarded-Proto header when TLS termination is set.

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

get/health/ready

Response

Health status

statusstring

Status always contains "ok".

Example response

{
  "status": "ok"
}