Control Planes
List Control Planes
Returns an array of control plane objects containing information about the Konnect Control Planes.
get/v2/control-planes
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filters a collection of control-planes.
labelsstring
Example:key:value,existCheck
Filter control planes in the response by associated labels.
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:created_at desc
Sorts a collection of control-planes. Supported sort attributes are:
- created_at
Response
A paginated list response for a collection of control planes.
Example response
{
"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": {
"env": "test"
},
"config": {
"control_plane_endpoint": "https://acfe5f253f.cp.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
"auth_type": "pinned_client_certs",
"proxy_urls": [
{
"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}