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.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A paginated list response for a collection of backend clusters.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]

The Kafka cluster.

* Additional properties are NOT allowed.
Show Child Parameters
get/event-gateways/{gatewayId}/backend-clusters
 
application/json

Create Backend Cluster

Creates a new backend cluster.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The request schema for creating a backend cluster.

* Additional properties are NOT allowed.
namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the backend cluster.

Default:

<= 512 characters

authenticationOne Of
required
BackendClusterAuthenticationAnonymousobject

Anonymous authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
Show Child Parameters
insecure_allow_anonymous_virtual_cluster_authboolean

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

bootstrap_serversarray[string]required

Endpoint in address:port format.

Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$

>= 1 characters>= 1 items

tlsobjectrequired
Show Child Parameters
metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

Default:60

>= 1<= 43200

labelsobject

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

Created

BackendCluster

The Kafka cluster.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The unique identifier of the backend cluster.

namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the backend cluster.

Default:

<= 512 characters

authenticationOne Of
required
BackendClusterAuthenticationAnonymousobject

Anonymous authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
Show Child Parameters
insecure_allow_anonymous_virtual_cluster_authboolean

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

bootstrap_serversarray[string]required

Endpoint in address:port format.

Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$

>= 1 characters>= 1 items

tlsobjectrequired
Show Child Parameters
metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

Default:60

>= 1<= 43200

labelsobject

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"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/event-gateways/{gatewayId}/backend-clusters

Body

{ "name": "name", "authentication": { "type": "anonymous" }, "bootstrap_servers": [], "tls": { "enabled": false } }
 
application/json

Get a Backend Cluster

Returns information about a specific backend cluster.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

backendClusterIdstring(uuid)required

The ID of the Backend Cluster.

Response

application/json

A single backend cluster object.

BackendCluster

The Kafka cluster.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The unique identifier of the backend cluster.

namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the backend cluster.

Default:

<= 512 characters

authenticationOne Of
required
BackendClusterAuthenticationAnonymousobject

Anonymous authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
Show Child Parameters
insecure_allow_anonymous_virtual_cluster_authboolean

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

bootstrap_serversarray[string]required

Endpoint in address:port format.

Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$

>= 1 characters>= 1 items

tlsobjectrequired
Show Child Parameters
metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

Default:60

>= 1<= 43200

labelsobject

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"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}
 
application/json

Update Backend Cluster

Updates an existing backend cluster.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

backendClusterIdstring(uuid)required

The ID of the Backend Cluster.

Body

application/json

The request schema for updating a backend cluster.

* Additional properties are NOT allowed.
namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the backend cluster.

Default:

<= 512 characters

authenticationOne Of
required
BackendClusterAuthenticationAnonymousobject

Anonymous authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
Show Child Parameters
insecure_allow_anonymous_virtual_cluster_authboolean

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

bootstrap_serversarray[string]required

Endpoint in address:port format.

Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$

>= 1 characters>= 1 items

tlsobjectrequired
Show Child Parameters
metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

Default:60

>= 1<= 43200

labelsobject

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

Updated backend cluster object.

BackendCluster

The Kafka cluster.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The unique identifier of the backend cluster.

namestringrequired

The unique name of the backend cluster.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the backend cluster.

Default:

<= 512 characters

authenticationOne Of
required
BackendClusterAuthenticationAnonymousobject

Anonymous authentication scheme for the backend cluster.

* Additional properties are NOT allowed.
Show Child Parameters
insecure_allow_anonymous_virtual_cluster_authboolean

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

bootstrap_serversarray[string]required

Endpoint in address:port format.

Match pattern:^(([a-zA-Z0-9\.\-]+)|\[([a-fA-F0-9:]+)\]):\d+$

>= 1 characters>= 1 items

tlsobjectrequired
Show Child Parameters
metadata_update_interval_secondsinteger

The interval at which metadata is updated in seconds.

Default:60

>= 1<= 43200

labelsobject

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"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}

Body

{ "name": "name", "authentication": { "type": "anonymous" }, "bootstrap_servers": [], "tls": { "enabled": false } }
 
application/json