Kong · Schema

CreateControlPlaneRequest

The request schema for the create control plane request.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
name string The name of the control plane.
description string The description of the control plane in Konnect.
cluster_type string The ClusterType value of the cluster associated with the Control Plane.
auth_type string The auth type value of the cluster associated with the Runtime Group.
cloud_gateway boolean Whether this control-plane can be used for cloud-gateways.
proxy_urls object
labels object
View JSON Schema on GitHub

JSON Schema

kong-createcontrolplanerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateControlPlaneRequest",
  "title": "CreateControlPlaneRequest",
  "x-speakeasy-entity": "GatewayControlPlane",
  "description": "The request schema for the create control plane request.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the control plane.",
      "type": "string",
      "example": "Test Control Plane"
    },
    "description": {
      "description": "The description of the control plane in Konnect.",
      "type": "string",
      "example": "A test control plane for exploration.",
      "nullable": false
    },
    "cluster_type": {
      "description": "The ClusterType value of the cluster associated with the Control Plane.",
      "type": "string",
      "example": "CLUSTER_TYPE_CONTROL_PLANE",
      "enum": [
        "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"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "auth_type": {
      "description": "The auth type value of the cluster associated with the Runtime Group.",
      "type": "string",
      "example": "pinned_client_certs",
      "enum": [
        "pinned_client_certs",
        "pki_client_certs"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "cloud_gateway": {
      "description": "Whether this control-plane can be used for cloud-gateways.",
      "type": "boolean",
      "example": false,
      "nullable": false
    },
    "proxy_urls": {
      "$ref": "#/components/schemas/ProxyURLs"
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}