COconfluent
Key Encryption Keys (v1)

Get a kek by name

get/dek-registry/v1/keks/{name}

Request

  • Base URL
    https://psrc-00000.region.provider.confluent.cloud
  • URL
    https://psrc-00000.region.provider.confluent.cloud/dek-registry/v1/keks/{name}
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Path parameters

namestring required

Name of the kek

Query parameters

deletedboolean

Whether to include deleted keys

Response

The kek info

namestring

Name of the kek

kmsTypestring

KMS type of the kek

kmsKeyIdstring

KMS key ID of the kek

kmsPropsobject

Properties of the kek

docstring

Description of the kek

sharedboolean

Whether the kek is shared

tsinteger

Timestamp of the kek

deletedboolean

Whether the kek is deleted

Example response

{
  "kmsProps": {
    "key": "kmsProps"
  },
  "shared": true,
  "deleted": true,
  "name": "name",
  "doc": "doc",
  "kmsKeyId": "kmsKeyId",
  "kmsType": "kmsType",
  "ts": 0
}

Changes

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