Sha256: ff1516a229517c417214adec24f24f4fc0d637ad6e38f9bacc00b9f21e082c62
Contents?: true
Size: 1.91 KB
Versions: 11
Compression:
Stored size: 1.91 KB
Contents
# OryClient::MetadataApi
All URIs are relative to *https://playground.projects.oryapis.com*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**get_version**](MetadataApi.md#get_version) | **GET** /version | Return Running Software Version. |
## get_version
> <GetVersion200Response> get_version
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.
### Examples
```ruby
require 'time'
require 'ory-client'
# setup authorization
OryClient.configure do |config|
# Configure Bearer authorization: oryAccessToken
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = OryClient::MetadataApi.new
begin
# Return Running Software Version.
result = api_instance.get_version
p result
rescue OryClient::ApiError => e
puts "Error when calling MetadataApi->get_version: #{e}"
end
```
#### Using the get_version_with_http_info variant
This returns an Array which contains the response data, status code and headers.
> <Array(<GetVersion200Response>, Integer, Hash)> get_version_with_http_info
```ruby
begin
# Return Running Software Version.
data, status_code, headers = api_instance.get_version_with_http_info
p status_code # => 2xx
p headers # => { ... }
p data # => <GetVersion200Response>
rescue OryClient::ApiError => e
puts "Error when calling MetadataApi->get_version_with_http_info: #{e}"
end
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**GetVersion200Response**](GetVersion200Response.md)
### Authorization
[oryAccessToken](../README.md#oryAccessToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
Version data entries
11 entries across 11 versions & 1 rubygems