Download OpenAPI specification:Download
Control Plane manager API
Returns an array of control planes objects.
| page[size] | integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items. |
| page[number] | integer Example: page[number]=1 Determines which page of the entities to retrieve. |
{- "meta": {
- "page": {
- "size": 1,
- "total": 10,
- "number": 3
}
}, - "data": [
- {
- "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}
]
}Create a new control plane
| name required | string (MeshControlPlaneName) [ 1 .. 100 ] characters ^[a-z0-9A-Z]{1}.*$ The name of the control plane. |
| description | string (MeshControlPlaneDescription) <= 250 characters |
Array of objects (MeshControlPlaneFeatures) | |
object or null (Labels) <= 10 properties Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. |
{- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}
}{- "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}Get the control plane
| cpId required | string <uuid> Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b Id of the Konnect resource |
{- "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}Delete the control plane
| cpId required | string <uuid> Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b Id of the Konnect resource |
{- "status": 401,
- "title": "Unauthenticated",
- "instance": "konnect:trace:4497422055499297627",
- "detail": "A valid token is required"
}Update a whole control plane
| cpId required | string <uuid> Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b Id of the Konnect resource |
| name required | string (MeshControlPlaneName) [ 1 .. 100 ] characters ^[a-z0-9A-Z]{1}.*$ The name of the control plane. |
| description | string (MeshControlPlaneDescription) <= 250 characters |
object or null (Labels) <= 10 properties Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. |
{- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}
}{- "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}Update an individual control plane.
| cpId required | string <uuid> Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b Id of the Konnect resource |
| name | string (MeshControlPlaneName) [ 1 .. 100 ] characters ^[a-z0-9A-Z]{1}.*$ The name of the control plane. |
| description | string <= 250 characters |
object or null (Labels) <= 10 properties Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters. |
{- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}
}{- "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
- "name": "Test Control Plane",
- "description": "A test control plane for exploration.",
- "labels": {
- "test": "true"
}, - "created_at": "2022-11-04T20:10:06.927Z",
- "updated_at": "2022-11-04T20:10:06.927Z"
}