Ory.Api.Metadata (ory_client v1.6.2)

API calls for all endpoints tagged Metadata.

Summary

Functions

get_version(connection, opts \\ [])

Return Running Software Version. This endpoint returns the version of Ory Kratos. 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 version will never refer to the cluster state, only to a single instance.

is_alive(connection, opts \\ [])

Check HTTP Server Status This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. 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.

is_ready(connection, opts \\ [])

Check HTTP Server and Database Status 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.

Functions

Link to this function

get_version(connection, opts \\ [])

@spec get_version(
  Tesla.Env.client(),
  keyword()
) :: {:ok, Ory.Model.GetVersion200Response.t()} | {:error, Tesla.Env.t()}

Return Running Software Version. This endpoint returns the version of Ory Kratos. 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 version 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.GetVersion200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

is_alive(connection, opts \\ [])

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

Check HTTP Server Status This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. 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, map()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

is_ready(connection, opts \\ [])

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

Check HTTP Server and Database Status 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.

Parameters

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

Returns

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