Update KMS

put

https://cluster.ip.address/v2/kms/{id}

Privileges: CLUSTER_MODIFY

Update KMS on the cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

ID of the KMS configured on the cluster.

Body Params

Parameters to update KMS on the cluster.

awsKmsParams

object

AWS KMS configuration updatable parameters.

gcpKmsParams

object

GCP KMS configuration updatable parameters.

ibmKmsParams

object

IBM KMS configuration updatable parameters.

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

KMIP compliant KMS configuration parameters.

name

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

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError