Sign in

v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
encryption-keys

List encryption keys

Lists all encryption keys for the workspace associated with the Management API key.

get/encryption-keys

Query parameters

status'enabled' | 'disabled'

Filters by encryption key status.

environmentstring

Filters by environment ID.

cursorstring

Cursor token used for pagination. Response will contain items appearing after the given cursor.

limitnumber

Sets the maximum number of items contained in a single page.

Headers

X-API-Versionstring required

Management API version.

Response

List of encryption keys matching the given query.

Example response

{
  "data": [
    {
      "id": "tok_No3jUysGLCDuqB3RnCVf1weo",
      "name": "My Encryption Key",
      "description": "Description for my encryption key",
      "status": "enabled",
      "environment": "ae_rrETjdWcfqI6AFsk",
      "previous_token": "eWDrrpGGLjDQW0LBA0Wj",
      "token": "eWDrrpGGLjDQW0LBA0Wj",
      "next_token": "eWDrrpGGLjDQW0LBA0Wj",
      "created_at": "2024-05-31T01:24:39.506Z",
      "last_activated_at": "2024-05-31T01:24:39.506Z",
      "last_rotated_at": "2024-05-31T01:24:39.506Z"
    }
  ],
  "metadata": {
    "pagination": {
      "next_cursor": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI"
    }
  }
}