List Nodes

Returns a list of nodes 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

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 nodes associated with an Event Gateway.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]
Show Child Parameters
get/event-gateways/{gatewayId}/nodes
 
application/json

Get a Node

Returns information about a specific node associated with the Event Gateway.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

eventGatewayNodeIdstring(uuid)required

The ID of the Event Gateway Node.

Response

application/json

A single node object.

GatewayNode

idstring(uuid)requiredread-only

The node ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

versionstringrequired

The string representation of the node current version.

last_seen_atstring(date-time)required

An ISO-8604 timestamp representation of node last seen date.

Example:2025-08-04T20:10:06.927Z

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of node creation date.

Example:2025-08-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of node update date.

Example:2025-08-04T20:10:06.927Z

config_applied_atstring(date-time)read-only

The time the node succeeds in applying the configuration.

config_versionstringread-only

The version number of the configuration applied by the node.

Example:v1.123

get/event-gateways/{gatewayId}/nodes/{eventGatewayNodeId}
 
application/json

Get Node Status

Returns information about the node status.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

eventGatewayNodeIdstring(uuid)required

The ID of the Event Gateway Node.

Response

application/json

The status of an event gateway node.

config_applied_atstring(date-time)required

The time the node succeeds in applying the configuration.

config_versionstringrequired

The version number of the configuration applied by the node.

Example:v1.123

get/event-gateways/{gatewayId}/nodes/{eventGatewayNodeId}/status
 
application/json

List Node Errors

Returns information about the node errors.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

eventGatewayNodeIdstring(uuid)required

The ID of the Event Gateway Node.

Response

application/json

A list of errors reported by an event gateway node.

* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required

An error reported by an event gateway node.

Show Child Parameters
get/event-gateways/{gatewayId}/nodes/{eventGatewayNodeId}/errors
 
application/json

EventGatewayInfo

object

The gateway object contains information about a Konnect gateway.

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

The gateway ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the Gateway.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the Gateway.

<= 512 characters

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-8604 timestamp representation of gateway creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of gateway update date.

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

nodes_totalintegerrequired

The total number of nodes associated with the Event Gateway.

virtual_clusters_totalintegerrequired

The total number of virtual clusters associated with the Event Gateway.

min_runtime_versionstringrequired

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

versionstringrequired

The version number of the event gateway. Every change to an entity
under this gateway will modify the version.

Example:v1.123

Example