Skip to main content

Get a kek by name

GET 
/dek-registry/v1/keks/:name

Get a kek by name

Request​

Responses​

The kek info

OpenAPI definition (YAML) 
paths:
  /dek-registry/v1/keks/{name}:
    get:
      tags:
      - Key Encryption Keys (v1)
      operationId: getKek
      parameters:
      - description: Name of the kek
        explode: false
        in: path
        name: name
        required: true
        schema:
          type: string
        style: simple
      - description: Whether to include deleted keys
        explode: true
        in: query
        name: deleted
        required: false
        schema:
          type: boolean
        style: form
      responses:
        '200':
          content:
            application/vnd.schemaregistry.v1+json:
              schema:
                example:
                  kmsProps:
                    key: kmsProps
                  shared: true
                  deleted: true
                  name: name
                  doc: doc
                  kmsKeyId: kmsKeyId
                  kmsType: kmsType
                  ts: 0
                properties:
                  name:
                    type: string
                    description: Name of the kek
                  kmsType:
                    type: string
                    description: KMS type of the kek
                  kmsKeyId:
                    type: string
                    description: KMS key ID of the kek
                  kmsProps:
                    type: object
                    additionalProperties:
                      type: string
                    description: Properties of the kek
                  doc:
                    type: string
                    description: Description of the kek
                  shared:
                    type: boolean
                    description: Whether the kek is shared
                  ts:
                    type: integer
                    description: Timestamp of the kek
                    format: int64
                  deleted:
                    type: boolean
                    description: Whether the kek is deleted
                type: object
                title: Kek
            application/vnd.schemaregistry+json; qs=0.9:
              schema:
                example:
                  kmsProps:
                    key: kmsProps
                  shared: true
                  deleted: true
                  name: name
                  doc: doc
                  kmsKeyId: kmsKeyId
                  kmsType: kmsType
                  ts: 0
                properties:
                  name:
                    type: string
                    description: Name of the kek
                  kmsType:
                    type: string
                    description: KMS type of the kek
                  kmsKeyId:
                    type: string
                    description: KMS key ID of the kek
                  kmsProps:
                    type: object
                    additionalProperties:
                      type: string
                    description: Properties of the kek
                  doc:
                    type: string
                    description: Description of the kek
                  shared:
                    type: boolean
                    description: Whether the kek is shared
                  ts:
                    type: integer
                    description: Timestamp of the kek
                    format: int64
                  deleted:
                    type: boolean
                    description: Whether the kek is deleted
                type: object
                title: Kek
            application/json; qs=0.5:
              schema:
                example:
                  kmsProps:
                    key: kmsProps
                  shared: true
                  deleted: true
                  name: name
                  doc: doc
                  kmsKeyId: kmsKeyId
                  kmsType: kmsType
                  ts: 0
                properties:
                  name:
                    type: string
                    description: Name of the kek
                  kmsType:
                    type: string
                    description: KMS type of the kek
                  kmsKeyId:
                    type: string
                    description: KMS key ID of the kek
                  kmsProps:
                    type: object
                    additionalProperties:
                      type: string
                    description: Properties of the kek
                  doc:
                    type: string
                    description: Description of the kek
                  shared:
                    type: boolean
                    description: Whether the kek is shared
                  ts:
                    type: integer
                    description: Timestamp of the kek
                    format: int64
                  deleted:
                    type: boolean
                    description: Whether the kek is deleted
                type: object
                title: Kek
          description: The kek info
        '404':
          description: Error code 40470 -- Key not found
        '422':
          description: Error code 42271 -- Invalid key
      security:
      - resource-api-key: []
      - external-access-token: []
      description: Get a kek by name
      servers:
      - url: https://psrc-00000.region.provider.confluent.cloud
        description: Confluent Cloud Schema Registry Endpoint.