Sign in
Mesh

Get the control plane

Get the control plane

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

Response

A response to creating 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"
}

Changes

Changed in 3 of the 52 revisions of this API.4

  • ddd4be7ea0732See the full diff
    • ○

      the response required property created_at became read-only for the status 200

      response-required-property-became-read-only

    • ○

      the response required property updated_at became read-only for the status 200

      response-required-property-became-read-only

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

  • ceb0484689541See the full diff
    • ○

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

      response-optional-property-added

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

  • 8aedc289a9381See the full diff
    • ○

      the name response's property pattern ^[a-z0-9A-Z]{1}.*$ was added for the status 200

      response-property-pattern-added