idstringrequired
ID of a control plane group
Get Control Plane Group Status
Returns the status of a control plane group, including existing conflicts.
get
Path Parameters
Response
application/json
Response
application/json
Status of a control plane group, including existing conflicts.
itemobject
The Group Status object contains information about the status of a control plane group.
Show Child Parameters
get/control-planes/{id}/group-status
Authentication
Path Parameters
application/json
GroupMembership
objectmembersarray[object]required
Show Child Parameters
Example
CreateControlPlaneRequest
objectThe request schema for the create control plane request.
* Additional properties are NOT allowed.
namestringrequired
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
cluster_typestring
The ClusterType value of the cluster associated with the Control Plane.
Allowed values:CLUSTER_TYPE_CONTROL_PLANECLUSTER_TYPE_K8S_INGRESS_CONTROLLERCLUSTER_TYPE_CONTROL_PLANE_GROUPCLUSTER_TYPE_SERVERLESS
Example:CLUSTER_TYPE_CONTROL_PLANE
auth_typestring
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
cloud_gatewayboolean
Whether this control-plane can be used for cloud-gateways.
proxy_urlsarray[object](set)
Proxy URL associated with reaching the data-planes connected to a control-plane.
Example:{"host":"example.com","port":443,"protocol":"https"}
* Additional properties are NOT allowed.
Show Child Parameters
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
Example
UpdateControlPlaneRequest
objectThe request schema for the update control plane request.
* Additional properties are NOT allowed.
namestring
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
auth_typestring
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
proxy_urlsarray[object](set)
Proxy URL associated with reaching the data-planes connected to a control-plane.
Example:{"host":"example.com","port":443,"protocol":"https"}
* Additional properties are NOT allowed.
Show Child Parameters
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
Example
ControlPlane
objectThe control plane object contains information about a Kong control plane.
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only
The control plane ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The name of the control plane.
Example:Test Control Plane
descriptionstring
The description of the control plane in Konnect.
Example:A test control plane for exploration.
labelsobject
Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.
Example:{"env":"test"}
configobjectrequired
CP configuration object for related access endpoints.
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8604 timestamp representation of control plane update date.
Example:2022-11-04T20:10:06.927Z
Example