v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB

Mesh

Update a whole control plane

put/v1/mesh/control-planes/{cpId}

Request body

namestring required

The name of the control plane.

descriptionstring

labelsMeshControlPlaneNonNullableLabels nullable

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Example request

{
  "name": "Test control plane",
  "description": "A control plane to handle traffic on development environment.",
  "labels": {
    "test": "true"
  }
}

Response

A response to updating a control plane.

idstring uuid required

ID of the control plane.

namestring required

The name of the control plane.

descriptionstring

labelsMeshControlPlaneLabels nullable

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  "name": "Test control plane",
  "description": "A control plane to handle traffic on development environment.",
  "labels": {
    "test": "true"
  },
  "created_at": "2023-01-11T02:30:42.227Z",
  "updated_at": "2023-01-11T02:30:42.227Z"
}