Getting StartedAPI ReferenceRecipesGitHub
API Reference

Create a KMS config.

post
https://cluster.ip.address/irisservices/api/v1/public/kmsConfig

Privileges: CLUSTER_MODIFY

Returns the created KMS config.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
awsKms
object | null

AWS KMS conifg.

azureKms
object | null

Azure KMS config.

cryptsoftKms
object | null

Cryptsoft KMS config.

gcpKms
object | null

GCP KMS config

ibmKms
object | null

IBM KMS conifg.

int64 | null

The Id of a KMS server.

string | null

Specifies name of the key.

string | null
enum

Specifies the consumption model for the KMS Key.
'Local' indicates an internal KMS object.
'FortKnox' indicates an FortKnox KMS object.

Allowed:
string | null

Specifies the name given to the KMS Server.

string | null
enum

Specifies the type of key mangement system.
'kInternalKMS' indicates an internal KMS object.
'kAwsKMS' indicates an Aws KMS object.
'kCryptsoftKMS' indicates a Cryptsoft KMS object.
'kAzureKMS' indicates a Azure KMS object.
'kIbmKMS' indicates a IBM KMS object.
'kGcpKMS' indicates a GCP KMS object.

Allowed:
string | null
enum

Specifies the usage type of the kms config. kArchival indicates
this is used for regular archival. kRpaasArchival indicates this
is used for RPaaS only.
'kArchival' indicates an internal KMS object.
'kRpaasArchival' indicates an Aws KMS object.

Allowed:
vaultIdList
array of int64s | null

Specifies the list of Vault Ids.

vaultIdList
viewBoxIdList
array of int64s | null

Specifies the list of View Box Ids.

viewBoxIdList
Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?