kms-key

Create KMS Key

Create a customer-managed unique KMS Key in your organization. A KMS Key is a logical representation of a cryptographic key material. It also includes metadata such as a UUID, a name and its state.

post/kms-key

Request

Request body

namestring required

A human-readable display name uniquely identifying the KMS key within the tenant space.

descriptionstring

An optional detailed description providing additional context about the key's intended use case.

usage'encrypt-decrypt'
multi-zoneboolean

True if this is a multi-zone key.

Response

Created new KMS key

descriptionstring

An optional detailed description providing additional context about the key's intended use case.

namestring required

The display name assigned to the KMS key.

multi-zoneboolean required

True if this is a multi-zone key.

source'exoscale-kms' required
usagestring required

The cryptographic operation constraints allowed on this key.

status'enabled' | 'disabled' | 'pending-deletion' required
status-sincestring date-time required

The timestamp indicating exactly when the current key status was last transitioned.

idstring uuid required

The globally unique identifier (UUID) assigned to the newly created KMS key.

origin-zonestring required

The creation zone of the KMS key.

created-atstring date-time required

The UTC timestamp showing when the KMS key was originally provisioned.

Changes

No recorded changes to this operation across all 1 revision of this API.