COcouchbase
CMEK

Get Key Metadata

Retrieves the full metadata details for a specific customer-managed encryption key within the organization.

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

  • Organization Owner
  • Organization Member

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

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

Request

Response

Successfully fetched the encryption key details based on its ID.

idstring uuid required

The unique identifier of the key.

namestring required

Name of the key.

descriptionstring required

Description of the Key.

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000",
  "name": "Test Key",
  "description": "Description of the cluster",
  "config": {
    "arn": "arn:aws:kms:us-west-2:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef"
  },
  "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
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.