SchemaRegistry

object

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

Example

SchemaRegistryConfluentSensitiveDataAware

object

A Confluent schema registry.

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"}

Example

SchemaRegistryConfluent

object

A Confluent schema registry.

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"}

Example

SchemaRegistryConfluentConfigSensitiveDataAware

object

The configuration of Confluent Schema Registry

schema_typestringrequired

The format of the message.

Allowed values:avrojson

endpointstring(uri)required

The endpoint of the Confluent schema registry.

>= 1 characters

timeout_secondsinteger

Total time in seconds from establishing connection to receive a response from schema registry.

Default:10

>= 1

authenticationOne Of

The authentication configuration for the schema registry.

SchemaRegistryAuthenticationBasicSensitiveDataAwareobject
Show Child Parameters
Example

SchemaRegistryConfluentConfig

object

The configuration of Confluent Schema Registry

schema_typestringrequired

The format of the message.

Allowed values:avrojson

endpointstring(uri)required

The endpoint of the Confluent schema registry.

>= 1 characters

timeout_secondsinteger

Total time in seconds from establishing connection to receive a response from schema registry.

Default:10

>= 1

authenticationOne Of

The authentication configuration for the schema registry.

SchemaRegistryAuthenticationBasicobject

Basic authentication scheme for the schema registry with username and password.

Show Child Parameters
Example