Sign in

e67df5d1f74e

latestOpenAPI 3.0.22026-08-062794201004.1 KB
CMEK

Create Azure Key Metadata For Project

Initializes the metadata record for a customer-managed encryption key stored for a project. This only applies to Azure.

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

  • Organization Owner
  • Project Owner
  • Project Manager

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

post/v4/organizations/{organizationId}/projects/{projectId}/cmek

Request body

namestring required

Name of the key.

descriptionstring

Description of the key.

Example request

{
  "name": "Test Key",
  "description": "Description of the Key",
  "config": {
    "keyLocation": "https://my-vault.vault.azure.net/keys/my-key/846dec161545466586fd1f19849dd1ef",
    "region": "eastus"
  }
}

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"
}