Skip to main content

Get a dek by subject and version

GET 
/dek-registry/v1/keks/:name/deks/:subject/versions/:version

Get a dek by subject and version

Request​

Responses​

The dek info

OpenAPI definition (YAML) 
paths:
  /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}:
    get:
      tags:
      - Data Encryption Keys (v1)
      operationId: getDekByVersion
      parameters:
      - description: Name of the kek
        explode: false
        in: path
        name: name
        required: true
        schema:
          type: string
        style: simple
      - description: Subject of the dek
        explode: false
        in: path
        name: subject
        required: true
        schema:
          type: string
        style: simple
      - description: Version of the dek
        explode: false
        in: path
        name: version
        required: true
        schema:
          type: string
        style: simple
      - description: Algorithm of the dek
        explode: true
        in: query
        name: algorithm
        required: false
        schema:
          enum:
          - AES128_GCM
          - AES256_GCM
          - AES256_SIV
          type: string
        style: form
      - 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:
                  kekName: kekName
                  keyMaterial: keyMaterial
                  deleted: true
                  subject: subject
                  encryptedKeyMaterial: encryptedKeyMaterial
                  version: 0
                  algorithm: AES128_GCM
                  ts: 6
                properties:
                  kekName:
                    type: string
                    description: Kek name of the dek
                  subject:
                    type: string
                    description: Subject of the dek
                  version:
                    type: integer
                    description: Version of the dek
                    format: int32
                  algorithm:
                    type: string
                    description: Algorithm of the dek
                    enum:
                    - AES128_GCM
                    - AES256_GCM
                    - AES256_SIV
                  encryptedKeyMaterial:
                    type: string
                    description: Encrypted key material of the dek
                  keyMaterial:
                    type: string
                    description: Raw key material of the dek
                  ts:
                    type: integer
                    description: Timestamp of the dek
                    format: int64
                  deleted:
                    type: boolean
                    description: Whether the dek is deleted
                type: object
                title: Dek
            application/vnd.schemaregistry+json; qs=0.9:
              schema:
                example:
                  kekName: kekName
                  keyMaterial: keyMaterial
                  deleted: true
                  subject: subject
                  encryptedKeyMaterial: encryptedKeyMaterial
                  version: 0
                  algorithm: AES128_GCM
                  ts: 6
                properties:
                  kekName:
                    type: string
                    description: Kek name of the dek
                  subject:
                    type: string
                    description: Subject of the dek
                  version:
                    type: integer
                    description: Version of the dek
                    format: int32
                  algorithm:
                    type: string
                    description: Algorithm of the dek
                    enum:
                    - AES128_GCM
                    - AES256_GCM
                    - AES256_SIV
                  encryptedKeyMaterial:
                    type: string
                    description: Encrypted key material of the dek
                  keyMaterial:
                    type: string
                    description: Raw key material of the dek
                  ts:
                    type: integer
                    description: Timestamp of the dek
                    format: int64
                  deleted:
                    type: boolean
                    description: Whether the dek is deleted
                type: object
                title: Dek
            application/json; qs=0.5:
              schema:
                example:
                  kekName: kekName
                  keyMaterial: keyMaterial
                  deleted: true
                  subject: subject
                  encryptedKeyMaterial: encryptedKeyMaterial
                  version: 0
                  algorithm: AES128_GCM
                  ts: 6
                properties:
                  kekName:
                    type: string
                    description: Kek name of the dek
                  subject:
                    type: string
                    description: Subject of the dek
                  version:
                    type: integer
                    description: Version of the dek
                    format: int32
                  algorithm:
                    type: string
                    description: Algorithm of the dek
                    enum:
                    - AES128_GCM
                    - AES256_GCM
                    - AES256_SIV
                  encryptedKeyMaterial:
                    type: string
                    description: Encrypted key material of the dek
                  keyMaterial:
                    type: string
                    description: Raw key material of the dek
                  ts:
                    type: integer
                    description: Timestamp of the dek
                    format: int64
                  deleted:
                    type: boolean
                    description: Whether the dek is deleted
                type: object
                title: Dek
          description: The dek info
        '404':
          description: Error code 40470 -- Key not found
        '422':
          description: Unprocessable entity. Error code 42202 -- Invalid version. Error code 42271 --
            Invalid key.
        '500':
          description: Error code 50070 -- Dek generation error
      security:
      - resource-api-key: []
      - external-access-token: []
      description: Get a dek by subject and version
      servers:
      - url: https://psrc-00000.region.provider.confluent.cloud
        description: Confluent Cloud Schema Registry Endpoint.