Update Event Gateway
Update an individual gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
UpdateGatewayRequest
The request schema for the update gateway request.
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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 specified, the minimum runtime version will not be updated.
Match pattern:^\d+\.\d+$
Example:1.1
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
A response to updating a gateway.
EventGatewayInfo
The gateway object contains information about a Konnect gateway.
The gateway ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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-8604 timestamp representation of gateway creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of gateway update date.
Example:2022-11-04T20:10:06.927Z
The total number of nodes associated with the Event Gateway.
The total number of virtual clusters associated with the Event Gateway.
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 specified, the minimum runtime version will be pinned to the latest available release.
Match pattern:^\d+\.\d+$
Example:1.1
The version number of the event gateway. Every change to an entity
under this gateway will modify the version.
Example:v1.123
Authentication
Path Parameters
Body
Partially Update Event Gateway
Patch an individual gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
PatchGatewayRequest
The request schema for the patch gateway request.
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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 specified, the minimum runtime version will not be updated.
Match pattern:^\d+\.\d+$
Example:1.1
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
A response to updating a gateway.
EventGatewayInfo
The gateway object contains information about a Konnect gateway.
The gateway ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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-8604 timestamp representation of gateway creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of gateway update date.
Example:2022-11-04T20:10:06.927Z
The total number of nodes associated with the Event Gateway.
The total number of virtual clusters associated with the Event Gateway.
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 specified, the minimum runtime version will be pinned to the latest available release.
Match pattern:^\d+\.\d+$
Example:1.1
The version number of the event gateway. Every change to an entity
under this gateway will modify the version.
Example:v1.123
Authentication
Path Parameters
Body
Delete Event Gateway
Delete an individual gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
No Content
Authentication
Path Parameters
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.