Get a TLS Trust Bundle

Returns information about a specific TLS trust bundle.

Requires a minimum runtime version of 1.1.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

tlsTrustBundleIdstring(uuid)required

The ID of the TLS trust bundle.

Response

application/json

A single TLS trust bundle object.

TLSTrustBundle

A TLS trust bundle defines a set of trusted certificate authorities (CAs) used for client certificate
verification during mutual TLS (mTLS). Trust bundles are referenced by TLS listener policies to
determine which client certificates are accepted.

Requires a minimum runtime version of 1.1.

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

The unique identifier of the TLS trust bundle.

namestringrequired

The unique name of the TLS trust bundle.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the TLS trust bundle.

Default:

<= 512 characters

configobjectrequired
Show Child Parameters
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}/tls-trust-bundles/{tlsTrustBundleId}
 
application/json

Update TLS Trust Bundle

Updates an existing TLS trust bundle.

Requires a minimum runtime version of 1.1.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

tlsTrustBundleIdstring(uuid)required

The ID of the TLS trust bundle.

Body

application/json

The request schema for updating a TLS trust bundle.

* Additional properties are NOT allowed.
namestring

The unique name of the TLS trust bundle.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the TLS trust bundle.

Default:

<= 512 characters

configobject
Show Child Parameters
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 TLS trust bundle object.

TLSTrustBundle

A TLS trust bundle defines a set of trusted certificate authorities (CAs) used for client certificate
verification during mutual TLS (mTLS). Trust bundles are referenced by TLS listener policies to
determine which client certificates are accepted.

Requires a minimum runtime version of 1.1.

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

The unique identifier of the TLS trust bundle.

namestringrequired

The unique name of the TLS trust bundle.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the TLS trust bundle.

Default:

<= 512 characters

configobjectrequired
Show Child Parameters
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}/tls-trust-bundles/{tlsTrustBundleId}

Body

{}
 
application/json

Delete TLS Trust Bundle

Deletes a specific TLS trust bundle associated with the Event Gateway.

Requires a minimum runtime version of 1.1.

delete

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

tlsTrustBundleIdstring(uuid)required

The ID of the TLS trust bundle.

Response

No Content

delete/event-gateways/{gatewayId}/tls-trust-bundles/{tlsTrustBundleId}
 

Event Gateway Nodes

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