Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
CMEK

Get Azure Key Metadata For Project

Retrieves the full metadata details for a specific Azure customer-managed encryption key in a project.

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
  • Project Viewer
  • Database Data Reader/Writer
  • Database Data Reader

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

get/v4/organizations/{organizationId}/projects/{projectId}/cmek/{cmekId}

Response

Successfully fetched the encryption key details based on its ID in a project.

idstring uuid required

The ID of the key created.

namestring required

Name of the key (up to 256 characters).

descriptionstring required

Description of the Key (up to 1024 characters).

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000",
  "name": "Test Key",
  "description": "Description of the cluster",
  "config": {
    "keyLocation": "https://my-vault.vault.azure.net/keys/my-key/846dec161545466586fd1f19849dd1ef",
    "region": "eastus"
  },
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  }
}