Event Gateway Schema Registries
Configure a schema registry that can be used to validate payloads when producing/consuming messages
List Schema Registries
Returns a list of schema registries associated with the specified Event Gateway.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filter documents returned in the response.
Show Child Parameters
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of schema registries.
Pagination metadata.
Show Child Parameters
A schema registry that contains schemas.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create Schema Registry
Creates a new schema registry associated with the specified Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The request schema for creating a schema registry.
SchemaRegistryCreate
The typed schema of the schema registry to create it.
One OfThe unique name of the schema registry.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The type of the schema registry.
Allowed values:confluent
The configuration of the schema registry.
Show Child Parameters
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
Response
Created
SchemaRegistry
A schema registry that contains schemas.
The unique name of the schema registry.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The type of the schema registry.
The configuration of the schema registry.
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"}
The unique identifier of the schema registry.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a Schema Registry
Returns information about a specific schema registry associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Schema Registry.
Response
application/json
Response
A single schema registry object.
SchemaRegistry
A schema registry that contains schemas.
The unique name of the schema registry.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The type of the schema registry.
The configuration of the schema registry.
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"}
The unique identifier of the schema registry.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Schema Registry
Updates an existing schema registry associated with the specified Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Schema Registry.
Body
application/json
Body
The request schema for updating a schema registry.
SchemaRegistryUpdate
The typed schema of the schema registry to modify it.
One OfThe unique name of the schema registry.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The type of the schema registry.
Allowed values:confluent
The configuration of the schema registry.
Show Child Parameters
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
Response
Updated schema registry object.
SchemaRegistry
A schema registry that contains schemas.
The unique name of the schema registry.
>= 1 characters<= 255 characters
A human-readable description of the virtual cluster.
Default:
<= 512 characters
The type of the schema registry.
The configuration of the schema registry.
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"}
The unique identifier of the schema registry.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z