Mesh

Update a whole control plane

Changed on

Update a whole control plane

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/mesh/control-planes/{cpId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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.

versionstring

The version of the control plane. Setting it propagates the change to the global control plane, and is the only way to move a control plane between versions.

Example request

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

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.

versionstring

The version of the control plane. Setting it propagates the change to the global control plane, and is the only way to move a control plane between versions.

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"
  },
  "version": "v3",
  "created_at": "2023-01-11T02:30:42.227Z",
  "updated_at": "2023-01-11T02:30:42.227Z"
}

Changes

  • 658ffb748f95Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 5d2b35832e3fRevision changes
    • warning

      added the new type enum value to the /////// response property for the response status