BackendClusterAuthenticationSaslPlain

object

SASL/PLAIN authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:sasl_plain

usernamestringrequired

A literal value or a reference to an existing secret as a template string expression.
The value is stored and returned by the API as-is, not treated as sensitive information.

>= 1 characters

passwordstringrequired

A sensitive value containing the secret or a reference to a secret as a template string expression.
If the value is provided as plain text, it is encrypted at rest and omitted from API responses.
If provided as an expression, the expression itself is stored and returned by the API.

>= 1 characters

Example:${vault.env['MY_ENV_VAR']}

Example

BackendClusterAuthenticationSaslScramSensitiveDataAware

object

SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:sasl_scram

algorithmstringrequired

The algorithm used for SASL/SCRAM authentication.

Allowed values:sha256sha512

usernamestringrequired

A literal value or a reference to an existing secret as a template string expression.
The value is stored and returned by the API as-is, not treated as sensitive information.

>= 1 characters

passwordstring

A sensitive value containing the secret or a reference to a secret as a template string expression.
If the value is provided as plain text, it is encrypted at rest and omitted from API responses.
If provided as an expression, the expression itself is stored and returned by the API.

>= 1 characters

Example:${vault.env['MY_ENV_VAR']}

Example

BackendClusterAuthenticationSaslScram

object

SASL/SCRAM authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:sasl_scram

algorithmstringrequired

The algorithm used for SASL/SCRAM authentication.

Allowed values:sha256sha512

usernamestringrequired

A literal value or a reference to an existing secret as a template string expression.
The value is stored and returned by the API as-is, not treated as sensitive information.

>= 1 characters

passwordstringrequired

A sensitive value containing the secret or a reference to a secret as a template string expression.
If the value is provided as plain text, it is encrypted at rest and omitted from API responses.
If provided as an expression, the expression itself is stored and returned by the API.

>= 1 characters

Example:${vault.env['MY_ENV_VAR']}

Example

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