EventGatewayTLSListenerPolicyConfigSensitiveDataAware

object
certificatesarray[object]required

A TLS certificate and its associated private key.

>= 1 items<= 1 items

Show Child Parameters
versionsobject

A range of TLS versions.

Default:{"min":"TLSv1.2","max":"TLSv1.3"}

Show Child Parameters
allow_plaintextboolean

If false, only TLS connections are allowed. If true, both TLS and plaintext connections are allowed.

Default:false

client_authenticationobject

Configures mutual TLS (mTLS) client certificate verification. When set, the gateway
requests or requires clients to present a certificate during the TLS handshake.

Requires a minimum runtime version of 1.1.

Show Child Parameters
Example

EventGatewayTLSListenerPolicyConfig

object
certificatesarray[object]required

A TLS certificate and its associated private key.

>= 1 items<= 1 items

Show Child Parameters
versionsobject

A range of TLS versions.

Default:{"min":"TLSv1.2","max":"TLSv1.3"}

Show Child Parameters
allow_plaintextboolean

If false, only TLS connections are allowed. If true, both TLS and plaintext connections are allowed.

Default:false

client_authenticationobject

Configures mutual TLS (mTLS) client certificate verification. When set, the gateway
requests or requires clients to present a certificate during the TLS handshake.

Requires a minimum runtime version of 1.1.

Show Child Parameters
Example

TLSCertificateSensitiveDataAware

object

A TLS certificate and its associated private key.

certificatestringrequired

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

keystring

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

TLSCertificate

object

A TLS certificate and its associated private key.

certificatestringrequired

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

keystringrequired

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

EventGatewayListenerPolicyCreate

The typed schema of the listener policy to modify it.

One Of
typestringrequired

The type name of the policy.

Allowed values:tls_server

>= 1 characters<= 255 characters

namestring

A unique user-defined name of the policy.

<= 255 characters

descriptionstring

A human-readable description of the policy.

Default:

<= 512 characters

enabledboolean

Whether the policy is enabled.

Default:true

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

configobjectrequired

The configuration of the policy.

Show Child Parameters
Example