How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Event Gateway Listener Policies API

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

9 operations 4 paths 42 schemas 1 DELETE3 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Event Gateway Listener Policies API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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.

GET
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies
List Policies for Listener
list-event-gateway-listener-policies 3 params → 200401403
POST
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies
Create Policy for Listener
create-event-gateway-listener-policy 4 params body → 201400401403
GET
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}
Get a Policy for Listener
get-event-gateway-listener-policy 3 params → 200401403404
PUT
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}
Update Policy for Listener
update-event-gateway-listener-policy 3 params body → 200400401403
PATCH
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}
Partially Update Policy for Listener
patch-event-gateway-listener-policy 3 params body → 200400401403
DELETE
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}
Delete Policy for Listener
delete-event-gateway-listener-policy 3 params → 204401403404
POST
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policies/{policyId}/move
Move Policy
move-event-gateway-listener-policy 3 params body → 204400401403
GET
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policy-chain
Get Policy Chain for Listener
get-event-gateway-listener-policy-chain 2 params → 200401403
PUT
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}/policy-chain
Update Policy Chain for Listener
update-event-gateway-listener-policy-chain 2 params body → 200400401403

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are EventGatewayListenerPolicy (10 properties), EventGatewayTLSListenerPolicy (6 properties), ForwardToVirtualClusterPolicy (6 properties), EventGatewayTLSListenerSensitiveDataAwarePolicy (6 properties). Each schema is shown below with its type and property counts.

BadRequestError
EventGatewayTLSListenerPolicyConfigSensitiveDataAware
object
4 properties 1 required
InvalidParameterMinimumLength
object
5 properties 4 required
BaseError
object
standard error
5 properties 4 required
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 properties 3 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
EventGatewayListenerPolicyCreate
The typed schema of the listener policy to modify it.
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 properties 2 required
UnauthorizedError
GatewaySecret
string
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…
NotFoundError
EventGatewayListenerPolicy
object
A policy associated with an Event Gateway.
10 properties 5 required
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property 1 required
EventGatewayTLSListenerPolicyConfig
object
4 properties 1 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…
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
MoveEventGatewayPolicy
object
Defines the position of a policy relative to the policy chain.
1 property 1 required
InvalidRules
string
invalid parameters rules
InvalidParameterChoiceItem
object
5 properties 4 required
VirtualClusterReference
A reference to a virtual cluster.
TLSTrustBundleReferenceByName
object
1 property 1 required
VirtualClusterReferenceById
object
Reference a virtual cluster by its unique identifier.
1 property 1 required
VirtualClusterName
string
The name of the virtual cluster.
TLSCertificate
object
A TLS certificate and its associated private key.
2 properties 2 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 properties 2 required
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,…
EventGatewayPolicyReference
string
The unique identifier of the policy.
InvalidParameters
array
invalid parameters
EventGatewayListenerPolicyPatch
object
The schema of the policy to patch it.
4 properties
TLSTrustBundleReferenceById
object
1 property 1 required
ForwardToClusterBySNIConfig
object
The configuration to forward requests to virtual clusters configured with SNI routing.
4 properties 1 required
ForbiddenError
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 properties 2 required
TLSVersionRange
object
A range of TLS versions.
2 properties
InvalidParameterDependentItem
object
5 properties 4 required
TLSTrustBundleName
string
The unique name of the TLS trust bundle.
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…
TLSCertificateSensitiveDataAware
object
A TLS certificate and its associated private key.
2 properties 1 required
EventGatewayListenerPolicyUpdate
The typed schema of the listener policy to modify it.
VirtualClusterReferenceByName
object
Reference a virtual cluster by its unique name.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-event-gateway-listener-policies-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Event Gateway Listener Policies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.