Get an Expected Config Hash

Retrieve the expected config hash for this control plane. The expected config hash can be used to verify if the config hash of a data plane node is up to date with the control plane. The config hash will be the same if they are in sync.

get

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

200 application/json

Response body for retrieving the expected config hash of the control plane.

expected_hashstringrequired

The expected configuration hash.

created_atintegerrequired

Date the control plane configuration was created.

updated_atintegerrequired

Date the control plane configuration was last updated.

get/control-planes/{controlPlaneId}/expected-config-hash
 
200 application/json

List Data Plane Node Records

Returns a list of data plane node records that are associated to this control plane. A data plane node record contains metadata information for the data plane running Kong 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

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

200 application/json

Example response

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/control-planes/{controlPlaneId}/nodes
 
200 application/json

List End-of-Life Data Plane Node Records

Returns a list of records of data plane nodes, whose versions are approaching End of Full Support/End of Life, that are associated with this control plane. Each record contains a data plane node’s id, version, and corresponding resolution message to upgrade to the closest Long Term Support version.

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

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

200 application/json

Example response

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/control-planes/{controlPlaneId}/nodes/eol
 
200 application/json

Get a Data Plane Node Record

Retrieve a specific data plane node record associated to this control plane. A data plane node record contains all the metadata information of the Kong Gateway dataplane.

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

nodeIdstring(uuid)required

Node identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

200 application/json

Example response

itemobject
Show Child Parameters
get/control-planes/{controlPlaneId}/nodes/{nodeId}
 
200 application/json

Delete Data Plane Node Record

Remove a specific data plane node record associated to this control plane. Deleting this record does not prevent the data plane node from re-connecting to the control plane.

delete

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

nodeIdstring(uuid)required

Node identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

204

No Content

delete/control-planes/{controlPlaneId}/nodes/{nodeId}
 
204