v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB

CMEK

Create Key Metadata

Initializes the metadata record for a customer-managed encryption key stored in AWS, GCP or Azure, linking it to the organization.

In order to access this endpoint, the provided API key must have at least one of the following roles:

Organization Owner

To learn more, see Organization, Project, and Database Access Overview.

post/v4/organizations/{organizationId}/cmek

Request body

namestring required

Name of the key (up to 256 characters).

descriptionstring

Description of the key (up to 1024 characters).

Example request

{
  "name": "Test Key",
  "description": "Description of the Key",
  "config": {
    "arn": "arn:aws:kms:us-west-2:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef"
  }
}

Response

Successfully created the encryption key metadata.

idstring uuid required

The ID of the KMS metadata created.

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000"
}