Ory.Api.Health (ory_oathkeeper v0.40.2)
API calls for all endpoints tagged Health
.
Link to this section 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.
Link to this section Functions
is_instance_alive(connection, opts \\ [])
@spec is_instance_alive( Tesla.Env.client(), keyword() ) :: {:ok, Ory.Model.GenericError.t()} | {:ok, Ory.Model.HealthStatus.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
Parameters
connection
(Ory.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, Ory.Model.HealthStatus.t}
on success{:error, Tesla.Env.t}
on failure
is_instance_ready(connection, opts \\ [])
@spec is_instance_ready( Tesla.Env.client(), keyword() ) :: {:ok, Ory.Model.HealthNotReadyStatus.t()} | {:ok, Ory.Model.HealthStatus.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
Parameters
connection
(Ory.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, Ory.Model.HealthStatus.t}
on success{:error, Tesla.Env.t}
on failure