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 Backend Clusters API

A backend cluster is an abstraction of a real Kafka cluster. It stores the connection and configuration details required for Kong Event Gateway to proxy traffic to Kafka.Multiple Kafka clusters can be proxied through a single Kong Event Gateway.

Kong Event Gateway Backend Clusters 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 Backend Clusters. 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 32 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 32 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 Backend Clusters 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 Backend Clusters 5

A backend cluster is an abstraction of a real Kafka cluster. It stores the connection and configuration details required for Kong Event Gateway to proxy traffic to Kafka. Multiple…

GET
/v1/event-gateways/{gatewayId}/backend-clusters
List Backend Clusters
list-event-gateway-backend-clusters 4 params → 200401403
POST
/v1/event-gateways/{gatewayId}/backend-clusters
Create Backend Cluster
create-event-gateway-backend-cluster 1 param body → 201400401403
GET
/v1/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}
Get a Backend Cluster
get-event-gateway-backend-cluster 2 params → 200401403404
PUT
/v1/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}
Update Backend Cluster
update-event-gateway-backend-cluster 2 params body → 200400401403
DELETE
/v1/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}
Delete Backend Cluster
delete-event-gateway-backend-cluster 2 params → 204401403404

Schemas 32

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

InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 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
BackendClusterAuthenticationScheme
CursorMetaPage
object
5 properties 3 required
CursorMeta
object
Pagination metadata.
1 property 1 required
BackendClusterAuthenticationAnonymous
object
Anonymous authentication scheme for the backend cluster.
1 property 1 required
BackendCluster
object
The Kafka cluster.
11 properties 7 required
BackendClusterAuthenticationSensitiveDataAwareScheme
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property 1 required
BackendClusterAuthenticationSaslScram
object
SASL/SCRAM authentication scheme for the backend cluster.
4 properties 4 required
BackendClusterAuthenticationSaslPlainSensitiveDataAware
object
SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
3 properties 2 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
BackendClusterAuthenticationSaslScramSensitiveDataAware
object
SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.
4 properties 3 required
InvalidParameterDependentItem
object
5 properties 4 required
BackendClusterName
string
The unique name of the backend cluster.
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
BackendClusterTLS
object
5 properties 1 required
InvalidParameterStandard
object
4 properties 2 required
BackendClusterAuthenticationSaslPlain
object
SASL/PLAIN authentication scheme for the backend cluster.
3 properties 3 required
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…
BootstrapServers
array
A list of cluster bootstrap servers in the format address:port.
NotFoundError
BackendMetadataUpdateIntervalSeconds
integer
The interval at which metadata is updated in seconds.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-event-gateway-backend-clusters-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