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

EventGatewayListener

object

Listeners are used to expose virtual clusters to clients.

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the listener.

namestringrequired

The unique name of the listener.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the listener.

Default:

<= 512 characters

addressesarray[string]required

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

portsOne Of
arrayrequired

Which 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

Variant 1string

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})$

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

Example

EventGatewayListenerAddresses

array

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 items