metadata

Check HTTP Server and Database Status

Changed on

This endpoint returns a HTTP 200 status code when Ory Kratos 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 Kratos, 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

Ory Kratos is ready to accept requests.

statusstring required

Always "ok".

Example response

{
  "status": "status"
}

Changes