Patch parts of control plane

Update an individual control plane.

patch

Path Parameters

cpIdstring(uuid)required

Id of the Konnect resource

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

Body

application/json

UpdateMeshControlPlaneRequest

a payload to update parts of the control plane

namestring

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"}

Response

application/json

A response to updating 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

patch/mesh/control-planes/{cpId}

Body

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

MeshControlPlaneFeatures

array
typestringrequired

Allowed values:MeshCreationHostnameGeneratorCreation

hostnameGeneratorCreation
Show Child Parameters
meshCreation
Show Child Parameters

MeshControlPlaneFeatureHostnameGenerationCreation

enabledbooleanrequired
Example

MeshControlPlaneFeatureMeshCreation

enabledbooleanrequired
Example

MeshControlPlaneFeature

object

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

typestringrequired

Allowed values:MeshCreationHostnameGeneratorCreation

hostnameGeneratorCreation
Show Child Parameters
meshCreation
Show Child Parameters
Example