Sign in
Mesh

Update a whole control plane

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.

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

Changed in 4 of the 29 revisions of this API.513

  • 658ffb748f952See the full diff
    • ○

      added the new optional request property version

      new-optional-request-property

    • ○

      added the optional property version to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5d2b35832e3f1See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecce2daf9de65See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

  • d0d31a247ed61See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog