Create a new control plane
Create a new control plane
Body
application/json
Body
CreateMeshControlPlaneRequest
a payload to create a control plane
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Features to be enabled in the control plane. Currently only defaults are supported.
Show Child Parameters
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Response
application/json
Response
A response to creating a control plane.
ControlPlane
a control plane
ID of the control plane.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Features to be enabled in the control plane. Currently only defaults are supported.
Show Child Parameters
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z
Authentication
Body
Get the control plane
Get the control plane
Path Parameters
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
A response to creating a control plane.
ControlPlane
a control plane
ID of the control plane.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Features to be enabled in the control plane. Currently only defaults are supported.
Show Child Parameters
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z
Authentication
Path Parameters
Delete the control plane
Delete the control plane
Path Parameters
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
Response
No Content
Authentication
Path Parameters
Update a whole control plane
Update a whole control plane
Path Parameters
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
PutMeshControlPlaneRequest
a payload to update the whole control plane
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Response
application/json
Response
A response to updating a control plane.
ControlPlane
a control plane
ID of the control plane.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Features to be enabled in the control plane. Currently only defaults are supported.
Show Child Parameters
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z
Authentication
Path Parameters
Body
Patch parts of control plane
Update an individual control plane.
Path Parameters
Id of the Konnect resource
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
UpdateMeshControlPlaneRequest
a payload to update parts of the control plane
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Response
application/json
Response
A response to updating a control plane.
ControlPlane
a control plane
ID of the control plane.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The name of the control plane.
Match pattern:^[a-z0-9A-Z]{1}.*$
>= 1 characters<= 100 characters
Example:Test control plane
<= 250 characters
Example:A control plane to handle traffic on development environment.
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.
Example:{"test":"true"}
Features to be enabled in the control plane. Currently only defaults are supported.
Show Child Parameters
Example:2023-01-11T02:30:42.227Z
Example:2023-01-11T02:30:42.227Z