Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

Konnect Control Planes

v2.0.0OAS 3.0

The API for Kong Konnect Control Planes.

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

Security
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.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

List Control Planes

Returns an array of control plane objects containing information about the Konnect Control Planes.

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[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of control-planes.

* Additional properties are NOT allowed.
Show Child Parameters
labelsstring

Filter control planes in the response by associated labels.

Example:key:value,existCheck

sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:name,created_at desc

Response

application/json

A paginated list response for a collection of control planes.

ListControlPlanesResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

The control plane object contains information about a Kong control plane.

* Additional properties are NOT allowed.
Show Child Parameters
get/control-planes
  
curl --request GET \
  --url 'https://us.api.konghq.com/v2/control-planes?page=&filter=&labels=key%3Avalue%2CexistCheck&sort=name%2Ccreated_at%20desc' \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json'
application/json
{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "name": "Test Control Plane",
      "description": "A test control plane for exploration.",
      "labels": {},
      "config": {
        "control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
        "telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
        "cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
        "auth_type": "pinned_client_certs",
        "cloud_gateway": false,
        "proxy_urls": [
          {
            "host": "host",
            "port": 0,
            "protocol": "protocol"
          }
        ]
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}