Sign in
Control Planes

Get a Control Plane

Returns information about an individual control plane.

get/v2/control-planes/{controlPlaneId}

Response

A response to retrieving a single control plane.

idstring uuid required

The control plane ID.

namestring required

The name of the control plane.

descriptionstring required

The description of the control plane in Konnect.

labelsLabels required

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time required

An ISO-8604 timestamp representation of control plane creation date.

updated_atstring date-time required

An ISO-8604 timestamp representation of control plane update date.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "Test Control Plane",
  "description": "A test control plane for exploration.",
  "labels": {
    "env": "test"
  },
  "config": {
    "control_plane_endpoint": "https://acfe5f253f.cp.konghq.com",
    "telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
    "cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
    "auth_type": "pinned_client_certs",
    "proxy_urls": [
      {
        "host": "example.com",
        "port": 443,
        "protocol": "https"
      }
    ]
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 1 of the 75 revisions of this API.3

  • 9296070059c53See the full diff
    • ○

      the response property config/proxy_urls became required for the status 200

      response-property-became-required

    • ○

      the response property description became required for the status 200

      response-property-became-required

    • ○

      the response property labels became required for the status 200

      response-property-became-required