Control Planes

Create Control Plane

Changed on

Create a control plane in the Konnect Organization.

post/v2/control-planes

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

The name of the control plane.

descriptionstring

The description of the control plane in Konnect.

cluster_type'CLUSTER_TYPE_CONTROL_PLANE' | 'CLUSTER_TYPE_K8S_INGRESS_CONTROLLER' | 'CLUSTER_TYPE_CONTROL_PLANE_GROUP' | 'CLUSTER_TYPE_SERVERLESS' | 'CLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXY' | 'CLUSTER_TYPE_SERVERLESS_V1'

The ClusterType value of the cluster associated with the Control Plane.

auth_type'pinned_client_certs' | 'pki_client_certs'

The auth type value of the cluster associated with the Runtime Group.

cloud_gatewayboolean

Whether this control-plane can be used for cloud-gateways.

labelsLabels

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 "_".

Example request

{
  "name": "Test Control Plane",
  "description": "A test control plane for exploration.",
  "cluster_type": "CLUSTER_TYPE_CONTROL_PLANE",
  "auth_type": "pinned_client_certs",
  "proxy_urls": [
    {
      "host": "example.com",
      "port": 443,
      "protocol": "https"
    }
  ],
  "labels": {
    "env": "test"
  }
}

Response

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

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

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

    • warning

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

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status