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 Gateways API

Create an Event Gateway Control Plane, used to store Event Gateway configuration

Kong Event Gateways 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 Gateways. 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 6 operations across 2 paths, and defines 25 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}.

6 operations 2 paths 25 schemas 1 DELETE2 GET1 PATCH1 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 Gateways 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 6

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

Event Gateways 6

Create an Event Gateway Control Plane, used to store Event Gateway configuration

GET
/v1/event-gateways
List all Event Gateways
list-event-gateways 3 params → 200400401403500503
POST
/v1/event-gateways
Create Event Gateway
create-event-gateway body → 201400401403404409500503
GET
/v1/event-gateways/{gatewayId}
Get an Event Gateway
get-event-gateway 1 param → 200400401403404500503
PUT
/v1/event-gateways/{gatewayId}
Update Event Gateway
update-event-gateway 1 param body → 200400401403404500503
PATCH
/v1/event-gateways/{gatewayId}
Partially Update Event Gateway
patch-event-gateway 1 param body → 200400401403404500503
DELETE
/v1/event-gateways/{gatewayId}
Delete Event Gateway
delete-event-gateway 1 param → 204401403404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are EventGatewayInfo (10 properties), BaseError (5 properties), CursorMetaPage (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.

MinRuntimeVersion
string
The minimum runtime version supported by the API. This is the lowest version of the data plane release that can be used with the entity model. When not specifi…
InvalidParameterMinimumLength
object
5 properties 4 required
GatewayName
string
The name of the Gateway.
ConflictError
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
PatchGatewayRequest
object
The request schema for the patch gateway request.
4 properties
UpdateGatewayRequest
object
The request schema for the update gateway request.
4 properties
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
GatewayDescription
string
A human-readable description of the Gateway.
UnauthorizedError
CursorMetaPage
object
5 properties 3 required
CursorMeta
object
Pagination metadata.
1 property 1 required
CreateGatewayRequest
object
The request schema for the create gateway request.
4 properties 1 required
EventGatewayInfo
object
The gateway object contains information about a Konnect gateway.
10 properties 8 required
MinRuntimeVersionUpdate
string
The minimum runtime version supported by the API. This is the lowest version of the data plane release that can be used with the entity model. When not specifi…
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
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-gateways-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