Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
CMEK

List Azure Key Metadata For Project

Retrieves detailed metadata for all Azure customer-managed encryption keys associated with the 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

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed the detailed metadata for all Azure encryption keys associated with the project.

Example response

{
  "data": [
    {
      "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
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}