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 Version

Retrieve the expected config version for this control plane. The expected config version can be used to verify if the config version of a data plane node is up to date with the control plane. The config version 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 version of the control plane.

expected_config_versionstringrequired

The expected configuration version.

created_atinteger

Date the control plane configuration version was created.

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

Custom Plugin Schemas

Custom Plugin Schemas

List Custom Plugin Schemas

Returns an array of custom plugins schemas associated with a control plane.

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

application/json

A paginated list response for a collection of custom plugin schemas.

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/control-planes/{controlPlaneId}/core-entities/plugin-schemas
 
application/json