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
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
Authentication
Query Parameters
application/json
Create Control Plane
Create a control plane in the Konnect Organization.
post
Body
application/json
Body
application/json
CreateControlPlaneRequest
The request schema for the create control plane request.
* Additional properties are NOT allowed.
namestringrequired
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
cluster_typestring
The ClusterType value of the cluster associated with the Control Plane.
Allowed values:CLUSTER_TYPE_CONTROL_PLANECLUSTER_TYPE_K8S_INGRESS_CONTROLLERCLUSTER_TYPE_CONTROL_PLANE_GROUPCLUSTER_TYPE_SERVERLESS
Example:CLUSTER_TYPE_CONTROL_PLANE
auth_typestring
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
cloud_gatewayboolean
Whether this control-plane can be used for cloud-gateways.
Example:false
proxy_urlsarray[object](set)
Proxy URL associated with reaching the data-planes connected to a control-plane.
Example:{"host":"example.com","port":443,"protocol":"https"}
* Additional properties are NOT allowed.
Show Child Parameters
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
Response
application/json
Response
application/json
A response to creating a control plane.
ControlPlane
The control plane object contains information about a Kong control plane.
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only
The control plane ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
configobjectrequired
CP configuration object for related access endpoints.
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane update date.
Example:2022-11-04T20:10:06.927Z
post/control-planes
Authentication
Body
{
"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER",
"cloud_gateway": false,
"proxy_urls": [
{
"host": "example.com",
"port": 443,
"protocol": "https"
}
],
"labels": {
"env": "test"
}
}
application/json
Fetch Control Plane
Returns information about an individual control plane.
get
Path Parameters
idstring(uuid)required
The control plane ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
application/json
A response to retrieving a single control plane.
ControlPlane
The control plane object contains information about a Kong control plane.
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only
The control plane ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
configobjectrequired
CP configuration object for related access endpoints.
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane update date.
Example:2022-11-04T20:10:06.927Z
get/control-planes/{id}
Authentication
Path Parameters
application/json
Update Control Plane
Update an individual control plane.
patch
Path Parameters
idstring(uuid)required
The control plane ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
application/json
UpdateControlPlaneRequest
The request schema for the update control plane request.
* Additional properties are NOT allowed.
namestring
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
auth_typestring
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
proxy_urlsarray[object](set)
Proxy URL associated with reaching the data-planes connected to a control-plane.
Example:{"host":"example.com","port":443,"protocol":"https"}
* Additional properties are NOT allowed.
Show Child Parameters
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
Response
application/json
Response
application/json
A response to updating a control plane.
ControlPlane
The control plane object contains information about a Kong control plane.
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only
The control plane ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
configobjectrequired
CP configuration object for related access endpoints.
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane update date.
Example:2022-11-04T20:10:06.927Z
patch/control-planes/{id}
Authentication
Path Parameters
Body
{
"name": "Test Control Plane",
"description": "A test control plane for exploration.",
"proxy_urls": [
{
"host": "example.com",
"port": 443,
"protocol": "https"
}
],
"labels": {
"env": "development"
}
}
application/json
Delete Control Plane
Delete an individual control plane.
delete
Path Parameters
idstring(uuid)required
The control plane ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
delete/control-planes/{id}