Ory.Api.Version (ory_oathkeeper v0.40.2)
API calls for all endpoints tagged Version
.
Link to this section 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.
Link to this section Functions
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
Parameters
connection
(Ory.Connection): Connection to serveropts
(keyword): Optional parameters
returns
Returns
{:ok, Ory.Model.Version.t}
on success{:error, Tesla.Env.t}
on failure