Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Event Gateway Listeners API

A listener represents hostname-port or IP-port combinations that connect to TCP sockets. Listeners need at least as many ports as backend brokers if you use port mapping in a Forward to Virtual Cluster policy. For SNI routing, you can route all brokers using a listener with only one port. Ports can be expressed as a single port or range. Addresses can be IPv4, IPv6, or hostnames.A listener can have policies that enforce TLS certificates and perform SNI routing. The listener runs at Layer 4 of the network stack. In Kong Event Gateway, listeners first take in the connection and then route the TCP connection to a virtual cluster based on conditions defined in listener policies.

Kong Event Gateway Listeners 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 Listeners. 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 5 operations across 2 paths, and defines 23 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}.

5 operations 2 paths 23 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Event Gateway Listeners 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Event Gateway Listeners 5

A listener represents hostname-port or IP-port combinations that connect to TCP sockets. Listeners need at least as many ports as backend brokers if you use port mapping in a Forw…

GET
/v1/event-gateways/{gatewayId}/listeners
List Event Gateway Listeners
list-event-gateway-listeners 4 params → 200401403
POST
/v1/event-gateways/{gatewayId}/listeners
Create Event Gateway Listener
create-event-gateway-listener 1 param body → 201400401403
GET
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}
Get an Event Gateway Listener
get-event-gateway-listener 2 params → 200401403404
PUT
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}
Update Event Gateway Listener
update-event-gateway-listener 2 params body → 200400401403
DELETE
/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}
Delete Event Gateway Listener
delete-event-gateway-listener 2 params → 204401403404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are EventGatewayListener (8 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties), InvalidParameterMinimumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
EventGatewayListener
object
Listeners are used to expose virtual clusters to clients.
8 properties 6 required
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
EventGatewayListenerAddresses
array
Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6. If 0.0.0.0 or :: is used, there c…
InvalidParameterMaximumLength
object
5 properties 4 required
EventGatewayListenerPort
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
CursorMetaPage
object
5 properties 3 required
CursorMeta
object
Pagination metadata.
1 property 1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
NotFoundError
EventGatewayListenerPorts
array
Which port or ports to listen on. There can be multiple ways to define ports: - as a single port, e.g. 9092 - as a range of ports, e.g. 9092-9094 It's possible…
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-event-gateway-listeners-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