Event Gateway Backend Clusters
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.
List Backend Clusters
Returns a list of backend clusters associated with the specified Event Gateway.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filter documents returned in the response.
Show Child Parameters
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of backend clusters.
Pagination metadata.
Show Child Parameters
The Kafka cluster.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create Backend Cluster
Creates a new backend cluster.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The request schema for creating a backend cluster.
The unique name of the backend cluster.
>= 1 characters<= 255 characters
A human-readable description of the backend cluster.
Default:
<= 512 characters
One OfAnonymous authentication scheme for the backend cluster.
Show Child Parameters
If true, virtual clusters can have allow anonymous authentication and use this backend cluster.
This setting is not recommended for production use as it may create privilege escalation vulnerabilities.
Default:false
Endpoint in address:port format.
Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$
>= 1 characters>= 1 items
Show Child Parameters
The interval at which metadata is updated in seconds.
Default:60
>= 1<= 43200
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
Created
BackendCluster
The Kafka cluster.
The unique identifier of the backend cluster.
The unique name of the backend cluster.
>= 1 characters<= 255 characters
A human-readable description of the backend cluster.
Default:
<= 512 characters
One OfAnonymous authentication scheme for the backend cluster.
Show Child Parameters
If true, virtual clusters can have allow anonymous authentication and use this backend cluster.
This setting is not recommended for production use as it may create privilege escalation vulnerabilities.
Default:false
Endpoint in address:port format.
Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$
>= 1 characters>= 1 items
Show Child Parameters
The interval at which metadata is updated in seconds.
Default:60
>= 1<= 43200
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a Backend Cluster
Returns information about a specific backend cluster.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Backend Cluster.
Response
application/json
Response
A single backend cluster object.
BackendCluster
The Kafka cluster.
The unique identifier of the backend cluster.
The unique name of the backend cluster.
>= 1 characters<= 255 characters
A human-readable description of the backend cluster.
Default:
<= 512 characters
One OfAnonymous authentication scheme for the backend cluster.
Show Child Parameters
If true, virtual clusters can have allow anonymous authentication and use this backend cluster.
This setting is not recommended for production use as it may create privilege escalation vulnerabilities.
Default:false
Endpoint in address:port format.
Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$
>= 1 characters>= 1 items
Show Child Parameters
The interval at which metadata is updated in seconds.
Default:60
>= 1<= 43200
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Backend Cluster
Updates an existing backend cluster.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Backend Cluster.
Body
application/json
Body
The request schema for updating a backend cluster.
The unique name of the backend cluster.
>= 1 characters<= 255 characters
A human-readable description of the backend cluster.
Default:
<= 512 characters
One OfAnonymous authentication scheme for the backend cluster.
Show Child Parameters
If true, virtual clusters can have allow anonymous authentication and use this backend cluster.
This setting is not recommended for production use as it may create privilege escalation vulnerabilities.
Default:false
Endpoint in address:port format.
Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$
>= 1 characters>= 1 items
Show Child Parameters
The interval at which metadata is updated in seconds.
Default:60
>= 1<= 43200
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
Updated backend cluster object.
BackendCluster
The Kafka cluster.
The unique identifier of the backend cluster.
The unique name of the backend cluster.
>= 1 characters<= 255 characters
A human-readable description of the backend cluster.
Default:
<= 512 characters
One OfAnonymous authentication scheme for the backend cluster.
Show Child Parameters
If true, virtual clusters can have allow anonymous authentication and use this backend cluster.
This setting is not recommended for production use as it may create privilege escalation vulnerabilities.
Default:false
Endpoint in address:port format.
Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$
>= 1 characters>= 1 items
Show Child Parameters
The interval at which metadata is updated in seconds.
Default:60
>= 1<= 43200
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z