Kong · Schema

UpdateControlPlaneRequest

The request schema for the update 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.
auth_type	string	The auth type value of the cluster associated with the Runtime Group.
proxy_urls	object
labels	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateControlPlaneRequest",
  "title": "UpdateControlPlaneRequest",
  "description": "The request schema for the update 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
    },
    "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"
    },
    "proxy_urls": {
      "$ref": "#/components/schemas/ProxyURLs"
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    }
  },
  "additionalProperties": false
}