Getting StartedAPI ReferenceRecipesGitHub
API Reference

Add KMS

post
https://helios.cohesity.com/v2/kms

Add a key management system(KMS) to the cluster.

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

Parameters to add KMS on the cluster.

string
enum
required

Type of KMS. 'InternalKms' indicates the internal cluster KMS. 'AwsKms' indicates AWS KMS. 'KmipKms' indicates any KMIP compliant KMS.

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.

Allowed:
string | null
enum

Specifies the ownership context of the kms config. 'Local' indicates this is used for regular archival. 'FortKnox' indicates this is used for FortKnox only.

Allowed:
ibmKmsParams
object | null

IBM KMS configuration parameters.

gcpKmsParams
object | null

GCP KMS configuration parameters.

awsKmsParams
object | null

AWS KMS configuration updatable parameters.

string
required

Name of the KMS.

storageDomainIds
array of int64s | null

Ids of storage domains used to assign the KMS for encryption. Once an external KMS (AWS KMS or KIMP KMS) is assigned to a storage domain, it cannot be changed.

storageDomainIds
externalTargetIds
array of int64s | null

Ids of external targets used to assign the KMS for encryption. Once an external KMS (AWS KMS or KIMP KMS) is assigned to an external target, it cannot be changed.

externalTargetIds
kmipKmsParams
object | null

KMIP compliant KMS configuration parameters.

Headers
int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Updated 4 months ago

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

Updated 4 months ago