Skip to main content

Create a dek

POST 

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

Create a dek

Request

Responses

The create response

OpenAPI definition (YAML)
paths:
  /dek-registry/v1/keks/{name}/deks:
    post:
      tags:
      - Data Encryption Keys (v1)
      operationId: createDek
      parameters:
      - description: Name of the kek
        explode: false
        in: path
        name: name
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/vnd.schemaregistry.v1+json:
            schema:
              example:
                subject: subject
                encryptedKeyMaterial: encryptedKeyMaterial
                version: 0
                algorithm: AES128_GCM
              properties:
                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
                deleted:
                  type: boolean
                  description: Whether the dek is deleted
              type: object
              title: CreateDekRequest
          application/vnd.schemaregistry+json:
            schema:
              example:
                subject: subject
                encryptedKeyMaterial: encryptedKeyMaterial
                version: 0
                algorithm: AES128_GCM
              properties:
                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
                deleted:
                  type: boolean
                  description: Whether the dek is deleted
              type: object
              title: CreateDekRequest
          application/json:
            schema:
              example:
                subject: subject
                encryptedKeyMaterial: encryptedKeyMaterial
                version: 0
                algorithm: AES128_GCM
              properties:
                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
                deleted:
                  type: boolean
                  description: Whether the dek is deleted
              type: object
              title: CreateDekRequest
          application/octet-stream:
            schema:
              example:
                subject: subject
                encryptedKeyMaterial: encryptedKeyMaterial
                version: 0
                algorithm: AES128_GCM
              properties:
                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
                deleted:
                  type: boolean
                  description: Whether the dek is deleted
              type: object
              title: CreateDekRequest
        description: The create request
        required: true
      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 create response
        '409':
          description: Conflict. Error code 40971 -- Key already exists. Error code 40972 -- Too many
            keys.
        '422':
          description: Error code 42271 -- Invalid key
        '500':
          description: Error code 50070 -- Dek generation error
      security:
      - resource-api-key: []
      - external-access-token: []
      description: Create a dek
      servers:
      - url: https://psrc-00000.region.provider.confluent.cloud
        description: Confluent Cloud Schema Registry Endpoint.
      jsonRequestBodyExample:
        subject: subject
        encryptedKeyMaterial: encryptedKeyMaterial
        version: 0
        algorithm: AES128_GCM