Get a Node
Returns information about a specific node associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Event Gateway Node.
Response
application/json
Response
A single node object.
GatewayNode
The node ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The string representation of the node current version.
An ISO-8604 timestamp representation of node last seen date.
Example:2025-08-04T20:10:06.927Z
An ISO-8604 timestamp representation of node creation date.
Example:2025-08-04T20:10:06.927Z
An ISO-8604 timestamp representation of node update date.
Example:2025-08-04T20:10:06.927Z
The time the node succeeds in applying the configuration.
The version number of the configuration applied by the node.
Example:v1.123
Authentication
Path Parameters
Get Node Status
Returns information about the node status.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Event Gateway Node.
Response
application/json
Response
The status of an event gateway node.
The time the node succeeds in applying the configuration.
The version number of the configuration applied by the node.
Example:v1.123
Authentication
Path Parameters
List Node Errors
Returns information about the node errors.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Event Gateway Node.
Response
application/json
Response
A list of errors reported by an event gateway node.
Pagination metadata.
Show Child Parameters
An error reported by an event gateway node.
Show Child Parameters
Authentication
Path Parameters
EventGatewayInfo
objectThe 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
EventGatewayListener
objectListeners are used to expose virtual clusters to clients.
The unique identifier of the listener.
The unique name of the listener.
>= 1 characters<= 255 characters
A human-readable description of the listener.
Default:
<= 512 characters
Which address or addresses to listen on.
0.0.0.0 means all addresses on the host.
:: means all addresses on the host in IPv6.
If 0.0.0.0 or :: is used, there can’t be other extra addresses defined.
WARNING: there are use cases where listening on all addresses is insecure. So use this with caution.
localhost means only the localhost ipv4 address.
>= 1 characters>= 1 items
One OfWhich port or ports to listen on.
There can be multiple ways to define ports:
- as a single port, e.g. 9092
- as a range of ports, e.g. 9092-9094
It’s possible to combine both, e.g. [9092, “9093-9095”, 9096].
>= 1 items
A port or a range of ports in the format 9092 or 9092-9094.
Match pattern:^(\d{1,5}|\d{1,5}-\d{1,5})$
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