3.14.0OAS 3.1

OpenAPI 3.0 spec for Kong Gateway’s Admin API.

You can learn more about Kong Gateway at developer.konghq.com.
Give Kong a star at the Kong/kong repository.

API Base URL
  • Server 1:https://us.api.konghq.com/v2

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v2

    Europe Production region

  • Server 3:https://au.api.konghq.com/v2

    Australia Production region

  • Server 4:https://me.api.konghq.com/v2

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v2

    India Production region

  • Server 6:https://sg.api.konghq.com/v2

    Singapore Production region

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.

DP Nodes

DP Nodes

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