ControlPlane

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ControlPlane",
  "title": "ControlPlane",
  "x-speakeasy-entity": "GatewayControlPlane",
  "description": "The control plane object contains information about a Kong control plane.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The control plane ID.",
      "type": "string",
      "format": "uuid",
      "example": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "readOnly": true,
      "x-speakeasy-param-suppress-computed-diff": true
    },
    "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
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "config": {
      "description": "CP configuration object for related access endpoints.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "control_plane_endpoint": {
          "description": "Control Plane Endpoint.",
          "type": "string",
          "format": "url",
          "example": "https://acfe5f253f.cp.konghq.com",
          "readOnly": true
        },
        "telemetry_endpoint": {
          "description": "Telemetry Endpoint.",
          "type": "string",
          "format": "url",
          "example": "https://acfe5f253f.tp0.konghq.com",
          "readOnly": true
        },
        "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"
          ],
          "readOnly": true,
          "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"
          ],
          "readOnly": true,
          "x-speakeasy-unknown-values": "allow"
        },
        "cloud_gateway": {
          "description": "Whether the Control Plane can be used for cloud-gateways.",
          "type": "boolean",
          "nullable": false,
          "readOnly": true
        },
        "proxy_urls": {
          "$ref": "#/components/schemas/ProxyURLs"
        }
      },
      "required": [
        "control_plane_endpoint",
        "telemetry_endpoint",
        "cluster_type",
        "auth_type",
        "cloud_gateway",
        "proxy_urls"
      ]
    },
    "created_at": {
      "description": "An ISO-8604 timestamp representation of control plane creation date.",
      "type": "string",
      "format": "date-time",
      "example": "2022-11-04T20:10:06.927Z",
      "readOnly": true,
      "x-speakeasy-terraform-ignore": true
    },
    "updated_at": {
      "description": "An ISO-8604 timestamp representation of control plane update date.",
      "type": "string",
      "format": "date-time",
      "example": "2022-11-04T20:10:06.927Z",
      "readOnly": true,
      "x-speakeasy-terraform-ignore": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "config",
    "created_at",
    "updated_at",
    "description",
    "labels"
  ]
}