Ory.Api.Health (ory_oathkeeper v0.40.5)

API calls for all endpoints tagged Health.

Summary

Functions

Check alive status This endpoint returns a 200 status code when the HTTP server is up running. 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.

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.

Functions

Link to this function

is_instance_alive(connection, opts \\ [])

@spec is_instance_alive(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Ory.Model.HealthStatus.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Check alive status This endpoint returns a 200 status code when the HTTP server is up running. 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.

Parameters

  • connection (Ory.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, Ory.Model.HealthStatus.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

is_instance_ready(connection, opts \\ [])

@spec is_instance_ready(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Ory.Model.HealthNotReadyStatus.t()}
  | {:ok, Ory.Model.HealthStatus.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (Ory.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, Ory.Model.HealthStatus.t} on success
  • {:error, Tesla.Env.t} on failure