Create Schema Registry

Creates a new schema registry associated with the specified Event Gateway.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The request schema for creating a schema registry.

SchemaRegistryCreate

SchemaRegistryCreate

The typed schema of the schema registry to create it.

One Of
namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

Allowed values:confluent

configobjectrequired

The configuration of the schema registry.

Show Child Parameters
labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Response

application/json

Created

SchemaRegistry

A schema registry that contains schemas.

namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

configobject

The configuration of the schema registry.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

idstring(uuid)required

The unique identifier of the schema registry.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/event-gateways/{gatewayId}/schema-registries

Body

{}
 
application/json

Get a Schema Registry

Returns information about a specific schema registry associated with the Event Gateway.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

schemaRegistryIdstring(uuid)required

The ID of the Schema Registry.

Response

application/json

A single schema registry object.

SchemaRegistry

A schema registry that contains schemas.

namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

configobject

The configuration of the schema registry.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

idstring(uuid)required

The unique identifier of the schema registry.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}
 
application/json

Update Schema Registry

Updates an existing schema registry associated with the specified Event Gateway.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

schemaRegistryIdstring(uuid)required

The ID of the Schema Registry.

Body

application/json

The request schema for updating a schema registry.

SchemaRegistryUpdate

SchemaRegistryUpdate

The typed schema of the schema registry to modify it.

One Of
namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

Allowed values:confluent

configobjectrequired

The configuration of the schema registry.

Show Child Parameters
labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Response

application/json

Updated schema registry object.

SchemaRegistry

A schema registry that contains schemas.

namestringrequired

The unique name of the schema registry.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the virtual cluster.

Default:

<= 512 characters

typestringrequired

The type of the schema registry.

configobject

The configuration of the schema registry.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

idstring(uuid)required

The unique identifier of the schema registry.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}

Body

{}
 
application/json

Delete Schema Registry

Deletes a specific schema registry associated with the Event Gateway.

delete

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

schemaRegistryIdstring(uuid)required

The ID of the Schema Registry.

Response

No Content

delete/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}
 

Event Gateway TLS Trust Bundles

A TLS trust bundle defines a set of trusted certificate authorities (CAs) used for client certificate
verification during mutual TLS (mTLS). Trust bundles are referenced by TLS listener policies to
determine which client certificates are accepted.