Policies control how Kafka protocol traffic is modified between the client and the backend cluster.Listener policies are routing policies that pass traffic to the virtual cluster.
Kong Event Gateway Listener Policies API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Event Gateway Listener Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
9 operations
across 4 paths,
and defines 42 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
9 operations4 paths42 schemas1 DELETE3 GET1 PATCH2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Kong Event Gateway Listener Policies API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
Paths & Operations 9
Across 4 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Event Gateway Listener Policies 9
Policies control how Kafka protocol traffic is modified between the client and the backend cluster. Listener policies are routing policies that pass traffic to the virtual cluster.
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are EventGatewayListenerPolicy (10 properties), ForwardToVirtualClusterPolicy (6 properties), EventGatewayTLSListenerPolicy (6 properties), EventGatewayTLSListenerSensitiveDataAwarePolicy (6 properties). Each schema is shown below with its type and property counts.
InvalidParameterMinimumLength
object
5 properties4 required
EventGatewayListenerPolicyPatch
object
The schema of the policy to patch it.
4 properties
ForwardToClusterBySNIConfig
object
The configuration to forward requests to virtual clusters configured with SNI routing.
4 properties1 required
TLSCertificate
object
A TLS certificate and its associated private key.
2 properties2 required
TLSTrustBundleReferenceByName
object
1 property1 required
TLSTrustBundleReferenceById
object
1 property1 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
EventGatewayListenerPolicyUpdate
The typed schema of the listener policy to modify it.
InvalidParameterChoiceItem
object
5 properties4 required
InvalidParameterMaximumLength
object
5 properties4 required
EventGatewayTLSListenerPolicy
object
The TLS Server policy defines the certificates and keys used by the gateway server when the client connects to the gateway over TLS. While it is possible to ha…
6 properties2 required
VirtualClusterReferenceById
object
Reference a virtual cluster by its unique identifier.
1 property1 required
GatewaySecretReferenceOrLiteral
string
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 sensiti…
Labels
object
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,…
ForbiddenError
UnauthorizedError
TLSTrustBundleName
string
The unique name of the TLS trust bundle.
EventGatewayListenerPolicyCreate
The typed schema of the listener policy to modify it.
ForwardToVirtualClusterPolicy
object
Forwards requests to virtual clusters configured with port routing or SNI routing. While there can be multiple of these policies configured on a listener, ther…
6 properties2 required
EventGatewayListenerPolicy
object
A policy associated with an Event Gateway.
10 properties5 required
EventGatewayTLSListenerSensitiveDataAwarePolicy
object
The TLS Server policy defines the certificates and keys used by the gateway server when the client connects to the gateway over TLS. While it is possible to ha…
6 properties2 required
EventGatewayPolicyReference
string
The unique identifier of the policy.
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
TLSTrustBundleReference
A reference to a TLS trust bundle resource. Either id or name must be provided. Following changes to the trust bundle name won't affect the reference, as the s…
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…
ForwardToClusterByPortMappingConfig
object
The configuration to forward request to destination and rewrite ports accordingly. All broker ids must fit in the range of ports defined in the listener, if it…
5 properties3 required
VirtualClusterName
string
The name of the virtual cluster.
MoveEventGatewayPolicy
object
Defines the position of a policy relative to the policy chain.
1 property1 required
NotFoundError
Specification
The full machine-readable OpenAPI contract behind this narrative.
