Skip to main content

Alters a kek

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

Alters a kek

Request​

Responses​

The update response

OpenAPI definition (YAML) 
paths:
  /dek-registry/v1/keks/{name}:
    put:
      tags:
      - Key Encryption Keys (v1)
      operationId: putKek
      parameters:
      - description: Name of the kek
        explode: false
        in: path
        name: name
        required: true
        schema:
          type: string
        style: simple
      - description: Whether to test kek sharing
        explode: true
        in: query
        name: testSharing
        required: false
        schema:
          type: boolean
          default: false
        style: form
      requestBody:
        content:
          application/vnd.schemaregistry.v1+json:
            schema:
              example:
                kmsProps:
                  key: kmsProps
                shared: true
                doc: doc
              properties:
                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
              type: object
              title: UpdateKekRequest
          application/vnd.schemaregistry+json:
            schema:
              example:
                kmsProps:
                  key: kmsProps
                shared: true
                doc: doc
              properties:
                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
              type: object
              title: UpdateKekRequest
          application/json:
            schema:
              example:
                kmsProps:
                  key: kmsProps
                shared: true
                doc: doc
              properties:
                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
              type: object
              title: UpdateKekRequest
          application/octet-stream:
            schema:
              example:
                kmsProps:
                  key: kmsProps
                shared: true
                doc: doc
              properties:
                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
              type: object
              title: UpdateKekRequest
        description: The update request
        required: true
      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 update response
        '404':
          description: Error code 40470 -- Key not found
        '409':
          description: Error code 40971 -- Key already exists
        '422':
          description: Error code 42271 -- Invalid key
      security:
      - resource-api-key: []
      - external-access-token: []
      description: Alters a kek
      servers:
      - url: https://psrc-00000.region.provider.confluent.cloud
        description: Confluent Cloud Schema Registry Endpoint.
      jsonRequestBodyExample:
        kmsProps:
          key: kmsProps
        shared: true
        doc: doc