0.0.1OAS 3.0

Control Plane manager API

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

    United-States Production region

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

    Europe Production region

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

    Australia Production region

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

    Middle-East Production region

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

    India Production region

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

    Singapore 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

Mesh

List Control Planes

Returns an array of control planes objects.

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

Response

application/json

A paginated list response for a collection of control planes.

ListMeshControlPlanesResponse

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

a control plane

Show Child Parameters
get/mesh/control-planes
 
application/json

Create a new control plane

Create a new control plane

post

Body

application/json

CreateMeshControlPlaneRequest

a payload to create a control plane

* Additional properties are NOT allowed.
namestringrequired

The name of the control plane.

Match pattern:^[a-z0-9A-Z]{1}.*$

>= 1 characters<= 100 characters

Example:Test control plane

descriptionstring

<= 250 characters

Example:A control plane to handle traffic on development environment.

featuresarray[object]

Features to be enabled in the control plane. Currently only defaults are supported.

Show Child Parameters
labelsobject | null

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Example:{"test":"true"}

Response

application/json

A response to creating a control plane.

ControlPlane

a control plane

idstring(uuid)requiredread-only

ID of the control plane.

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

namestringrequired

The name of the control plane.

Match pattern:^[a-z0-9A-Z]{1}.*$

>= 1 characters<= 100 characters

Example:Test control plane

descriptionstring

<= 250 characters

Example:A control plane to handle traffic on development environment.

labelsobject | null

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Example:{"test":"true"}

featuresarray[object]

Features to be enabled in the control plane. Currently only defaults are supported.

Show Child Parameters
created_atstring(date-time)requiredread-only

Example:2023-01-11T02:30:42.227Z

updated_atstring(date-time)requiredread-only

Example:2023-01-11T02:30:42.227Z

post/mesh/control-planes

Body

{ "name": "Test Control Plane", "description": "A test control plane for exploration.", "labels": { "test": "true" } }
 
application/json

Get the control plane

Get the control plane

get

Path Parameters

cpIdstring(uuid)required

Id of the Konnect resource

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

A response to creating a control plane.

ControlPlane

a control plane

idstring(uuid)requiredread-only

ID of the control plane.

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

namestringrequired

The name of the control plane.

Match pattern:^[a-z0-9A-Z]{1}.*$

>= 1 characters<= 100 characters

Example:Test control plane

descriptionstring

<= 250 characters

Example:A control plane to handle traffic on development environment.

labelsobject | null

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Example:{"test":"true"}

featuresarray[object]

Features to be enabled in the control plane. Currently only defaults are supported.

Show Child Parameters
created_atstring(date-time)requiredread-only

Example:2023-01-11T02:30:42.227Z

updated_atstring(date-time)requiredread-only

Example:2023-01-11T02:30:42.227Z

get/mesh/control-planes/{cpId}
 
application/json