Ory.Api.Metadata (ory_client v1.19.0)

API calls for all endpoints tagged Metadata.

Summary

Functions

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.

Functions

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