---
title: ConfigurationApi
---

## PureCloud::ConfigurationApi

All URIs are relative to *https://api.mypurecloud.com*

Method | HTTP request | Description
------------- | ------------- | -------------
|[**get_recordingkeys**](ConfigurationApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list|
|[**get_recordingkeys_rotationschedule**](ConfigurationApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule|
|[**post_recordingkeys**](ConfigurationApi.html#post_recordingkeys) | **POST** /api/v2/recording/recordingkeys | Create encryption key|
|[**put_recordingkeys_rotationschedule**](ConfigurationApi.html#put_recordingkeys_rotationschedule) | **PUT** /api/v2/recording/recordingkeys/rotationschedule | Update key rotation schedule|
{: class="table table-striped"}

<a name="get_recordingkeys"></a>

## -[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recordingkeys(opts)

Get encryption key list



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConfigurationApi.new

opts = { 
  page_size: 25, # Integer | Page size
  page_number: 1 # Integer | Page number
}

begin
  #Get encryption key list
  result = api_instance.get_recordingkeys(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConfigurationApi->get_recordingkeys: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_size** | **Integer**| Page size | [optional] [default to 25]
 **page_number** | **Integer**| Page number | [optional] [default to 1]
{: class="table table-striped"}


### Return type

[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html)

### HTTP request headers

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



<a name="get_recordingkeys_rotationschedule"></a>

## -[**KeyRotationSchedule**](KeyRotationSchedule.html) get_recordingkeys_rotationschedule

Get key rotation schedule



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConfigurationApi.new

begin
  #Get key rotation schedule
  result = api_instance.get_recordingkeys_rotationschedule
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConfigurationApi->get_recordingkeys_rotationschedule: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**KeyRotationSchedule**](KeyRotationSchedule.html)

### HTTP request headers

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



<a name="post_recordingkeys"></a>

## -[**EncryptionKey**](EncryptionKey.html) post_recordingkeys

Create encryption key



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConfigurationApi.new

begin
  #Create encryption key
  result = api_instance.post_recordingkeys
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConfigurationApi->post_recordingkeys: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**EncryptionKey**](EncryptionKey.html)

### HTTP request headers

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



<a name="put_recordingkeys_rotationschedule"></a>

## -[**KeyRotationSchedule**](KeyRotationSchedule.html) put_recordingkeys_rotationschedule(opts)

Update key rotation schedule



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConfigurationApi.new

opts = { 
  body: PureCloud::KeyRotationSchedule.new # KeyRotationSchedule | KeyRotationSchedule
}

begin
  #Update key rotation schedule
  result = api_instance.put_recordingkeys_rotationschedule(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConfigurationApi->put_recordingkeys_rotationschedule: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**KeyRotationSchedule**](KeyRotationSchedule.html)| KeyRotationSchedule | [optional] 
{: class="table table-striped"}


### Return type

[**KeyRotationSchedule**](KeyRotationSchedule.html)

### HTTP request headers

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