OmniCoreClient::VaultApi

All URIs are relative to https://api.korewireless.com

Method	HTTP request	Description
create_vault_configuration	POST /vault/subscriptions/{subscriptionid}/configurations
create_vault_key	POST /vault/subscriptions/{subscriptionid}/encryptionkeys
delete_configuration	DELETE /vault/subscriptions/{subscriptionid}/configurations/{configid}
delete_vault_key	DELETE /vault/subscriptions/{subscriptionid}/encryptionkeys/{keyid}
enable_encryption	POST /vault/subscriptions/{subscriptionid}/encryption
get_exports	GET /vault/subscriptions/{subscriptionid}/exports
get_registry_data	GET /vault/subscriptions/{subscriptionid}/folders
get_replays	GET /vault/subscriptions/{subscriptionid}/replays
get_vault_audit	GET /vault/subscriptions/{subscriptionid}/audit
get_vault_configurations	GET /vault/subscriptions/{subscriptionid}/configurations
get_vault_files	GET /vault/subscriptions/{subscriptionid}/registry/{registryid}/files
get_vault_keys	GET /vault/subscriptions/{subscriptionid}/encryptionkeys
get_vault_metrics	GET /vault/subscriptions/{subscriptionid}/metrics
get_vault_status	GET /vault/subscriptions/{subscriptionid}/status
set_retention	POST /vault/subscriptions/{subscriptionid}/retention
start_export	POST /vault/subscriptions/{subscriptionid}/exports
start_replay	POST /vault/subscriptions/{subscriptionid}/replays

create_vault_configuration

create_vault_configuration(subscriptionid, opts)

create vault configuration

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  create_configuration: OmniCoreClient::CreateConfiguration.new # CreateConfiguration | application/json
}

begin
  
  result = api_instance.create_vault_configuration(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->create_vault_configuration: #{e}"
end

Using the create_vault_configuration_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_vault_configuration_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.create_vault_configuration_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->create_vault_configuration_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
create_configuration	CreateConfiguration	application/json	[optional]

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

create_vault_key

create_vault_key(subscriptionid, opts)

Create Vault Key

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  create_vault_key_body: OmniCoreClient::CreateVaultKeyBody.new # CreateVaultKeyBody | application/json
}

begin
  
  result = api_instance.create_vault_key(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->create_vault_key: #{e}"
end

Using the create_vault_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_vault_key_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.create_vault_key_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->create_vault_key_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
create_vault_key_body	CreateVaultKeyBody	application/json	[optional]

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_configuration

delete_configuration(subscriptionid, configid)

Delete Configuration

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
configid = 'configid_example' # String | config id

begin
  
  result = api_instance.delete_configuration(subscriptionid, configid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->delete_configuration: #{e}"
end

Using the delete_configuration_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_configuration_with_http_info(subscriptionid, configid)

begin
  
  data, status_code, headers = api_instance.delete_configuration_with_http_info(subscriptionid, configid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->delete_configuration_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
configid	String	config id

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_vault_key

delete_vault_key(subscriptionid, keyid)

Delete Vault Key

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
keyid = 'keyid_example' # String | key id

begin
  
  result = api_instance.delete_vault_key(subscriptionid, keyid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->delete_vault_key: #{e}"
end

Using the delete_vault_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_vault_key_with_http_info(subscriptionid, keyid)

begin
  
  data, status_code, headers = api_instance.delete_vault_key_with_http_info(subscriptionid, keyid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->delete_vault_key_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
keyid	String	key id

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

enable_encryption

enable_encryption(subscriptionid, opts)

Enable Encryption

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  enable_encryption_body: OmniCoreClient::EnableEncryptionBody.new # EnableEncryptionBody | application/json
}

begin
  
  result = api_instance.enable_encryption(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->enable_encryption: #{e}"
end

Using the enable_encryption_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> enable_encryption_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.enable_encryption_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->enable_encryption_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
enable_encryption_body	EnableEncryptionBody	application/json	[optional]

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

get_exports

get_exports(subscriptionid)

Get Exports

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID

begin
  
  result = api_instance.get_exports(subscriptionid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_exports: #{e}"
end

Using the get_exports_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_exports_with_http_info(subscriptionid)

begin
  
  data, status_code, headers = api_instance.get_exports_with_http_info(subscriptionid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetExportsResponse>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_exports_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID

Return type

GetExportsResponse

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_registry_data

get_registry_data(subscriptionid)

Get vault folder data

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID

begin
  
  result = api_instance.get_registry_data(subscriptionid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_registry_data: #{e}"
end

Using the get_registry_data_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_registry_data_with_http_info(subscriptionid)

begin
  
  data, status_code, headers = api_instance.get_registry_data_with_http_info(subscriptionid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FolderData>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_registry_data_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID

Return type

FolderData

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_replays

get_replays(subscriptionid)

Get Replays

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID

begin
  
  result = api_instance.get_replays(subscriptionid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_replays: #{e}"
end

Using the get_replays_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_replays_with_http_info(subscriptionid)

begin
  
  data, status_code, headers = api_instance.get_replays_with_http_info(subscriptionid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetReplaysResponse>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_replays_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID

Return type

GetReplaysResponse

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_vault_audit

get_vault_audit(subscriptionid, opts)

Get vault Audit

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  page_number: 56, # Integer | Page Number
  page_size: 56 # Integer | Page Size
}

begin
  
  result = api_instance.get_vault_audit(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_audit: #{e}"
end

Using the get_vault_audit_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_vault_audit_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.get_vault_audit_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AuditResult>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_audit_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
page_number	Integer	Page Number	[optional]
page_size	Integer	Page Size	[optional]

Return type

AuditResult

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_vault_configurations

get_vault_configurations(subscriptionid)

Get vault configurations

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID

begin
  
  result = api_instance.get_vault_configurations(subscriptionid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_configurations: #{e}"
end

Using the get_vault_configurations_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_vault_configurations_with_http_info(subscriptionid)

begin
  
  data, status_code, headers = api_instance.get_vault_configurations_with_http_info(subscriptionid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Configurations>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_configurations_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID

Return type

Configurations

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_vault_files

get_vault_files(subscriptionid, registryid, opts)

Get vault files

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
registryid = 'registryid_example' # String | registry ID
opts = {
  file_type: 'file_type_example' # String | file type
}

begin
  
  result = api_instance.get_vault_files(subscriptionid, registryid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_files: #{e}"
end

Using the get_vault_files_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_vault_files_with_http_info(subscriptionid, registryid, opts)

begin
  
  data, status_code, headers = api_instance.get_vault_files_with_http_info(subscriptionid, registryid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FileDetails>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_files_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
registryid	String	registry ID
file_type	String	file type	[optional]

Return type

FileDetails

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_vault_keys

get_vault_keys(subscriptionid)

Get Vault Keys

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID

begin
  
  result = api_instance.get_vault_keys(subscriptionid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_keys: #{e}"
end

Using the get_vault_keys_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_vault_keys_with_http_info(subscriptionid)

begin
  
  data, status_code, headers = api_instance.get_vault_keys_with_http_info(subscriptionid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetKeysResponse>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_keys_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID

Return type

GetKeysResponse

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_vault_metrics

get_vault_metrics(subscriptionid, opts)

Get vault metrics

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  start_time: 'start_time_example', # String | start time
  end_time: 'end_time_example' # String | end time
}

begin
  
  result = api_instance.get_vault_metrics(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_metrics: #{e}"
end

Using the get_vault_metrics_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_vault_metrics_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.get_vault_metrics_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MetricsResponse>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_metrics_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
start_time	String	start time	[optional]
end_time	String	end time	[optional]

Return type

MetricsResponse

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_vault_status

get_vault_status(subscriptionid)

Get vault status

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID

begin
  
  result = api_instance.get_vault_status(subscriptionid)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_status: #{e}"
end

Using the get_vault_status_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_vault_status_with_http_info(subscriptionid)

begin
  
  data, status_code, headers = api_instance.get_vault_status_with_http_info(subscriptionid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <VaultStatus>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->get_vault_status_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID

Return type

VaultStatus

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

set_retention

set_retention(subscriptionid, opts)

Set Retention Period

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  set_retention_body: OmniCoreClient::SetRetentionBody.new # SetRetentionBody | application/json
}

begin
  
  result = api_instance.set_retention(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->set_retention: #{e}"
end

Using the set_retention_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> set_retention_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.set_retention_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->set_retention_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
set_retention_body	SetRetentionBody	application/json	[optional]

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

start_export

start_export(subscriptionid, opts)

Start Export

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  start_export_body: OmniCoreClient::StartExportBody.new # StartExportBody | application/json
}

begin
  
  result = api_instance.start_export(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->start_export: #{e}"
end

Using the start_export_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> start_export_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.start_export_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Frame>
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->start_export_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
start_export_body	StartExportBody	application/json	[optional]

Return type

Frame

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

start_replay

String start_replay(subscriptionid, opts)

Start Replay

Examples

require 'time'
require 'omnicore_client'
# setup authorization
OmniCoreClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'

  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OmniCoreClient::VaultApi.new
subscriptionid = 'subscriptionid_example' # String | Subscription ID
opts = {
  replay_body: OmniCoreClient::ReplayBody.new # ReplayBody | application/json
}

begin
  
  result = api_instance.start_replay(subscriptionid, opts)
  p result
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->start_replay: #{e}"
end

Using the start_replay_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(String, Integer, Hash)> start_replay_with_http_info(subscriptionid, opts)

begin
  
  data, status_code, headers = api_instance.start_replay_with_http_info(subscriptionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => String
rescue OmniCoreClient::ApiError => e
  puts "Error when calling VaultApi->start_replay_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
subscriptionid	String	Subscription ID
replay_body	ReplayBody	application/json	[optional]

Return type

String

Authorization

apiKey, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

VaultApi.md

Latest commit

History

VaultApi.md

File metadata and controls

OmniCoreClient::VaultApi

create_vault_configuration

Examples

Using the create_vault_configuration_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_vault_key

Examples

Using the create_vault_key_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_configuration

Examples

Using the delete_configuration_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_vault_key

Examples

Using the delete_vault_key_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

enable_encryption

Examples

Using the enable_encryption_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_exports

Examples

Using the get_exports_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_registry_data

Examples

Using the get_registry_data_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_replays

Examples

Using the get_replays_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_vault_audit

Examples

Using the get_vault_audit_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_vault_configurations

Examples

Using the get_vault_configurations_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_vault_files

Examples

Using the get_vault_files_with_http_info variant