Ory.Api.Version (ory_oathkeeper v0.40.6)

API calls for all endpoints tagged Version.

Summary

Functions

Get service version This endpoint returns the service version typically notated using semantic versioning. 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

get_version(connection, opts \\ [])

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

Get service version This endpoint returns the service version typically notated using semantic versioning. 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.Version.t} on success
  • {:error, Tesla.Env.t} on failure