OpenAPI definition (YAML)
paths:
/dek-registry/v1/keks:
post:
tags:
- Key Encryption Keys (v1)
operationId: createKek
parameters:
- 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
name: name
doc: doc
kmsKeyId: kmsKeyId
kmsType: kmsType
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
deleted:
type: boolean
description: Whether the kek is deleted
type: object
title: CreateKekRequest
application/vnd.schemaregistry+json:
schema:
example:
kmsProps:
key: kmsProps
shared: true
name: name
doc: doc
kmsKeyId: kmsKeyId
kmsType: kmsType
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
deleted:
type: boolean
description: Whether the kek is deleted
type: object
title: CreateKekRequest
application/json:
schema:
example:
kmsProps:
key: kmsProps
shared: true
name: name
doc: doc
kmsKeyId: kmsKeyId
kmsType: kmsType
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
deleted:
type: boolean
description: Whether the kek is deleted
type: object
title: CreateKekRequest
application/octet-stream:
schema:
example:
kmsProps:
key: kmsProps
shared: true
name: name
doc: doc
kmsKeyId: kmsKeyId
kmsType: kmsType
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
deleted:
type: boolean
description: Whether the kek is deleted
type: object
title: CreateKekRequest
description: The create 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 create response
'409':
description: Conflict. Error code 40971 -- Key already exists. Error code 40972 -- Too many
keys.
'422':
description: Error code 42271 -- Invalid key
security:
- resource-api-key: []
- external-access-token: []
description: Create a kek
servers:
- url: https://psrc-00000.region.provider.confluent.cloud
description: Confluent Cloud Schema Registry Endpoint.
jsonRequestBodyExample:
kmsProps:
key: kmsProps
shared: true
name: name
doc: doc
kmsKeyId: kmsKeyId
kmsType: kmsType