idstringrequired
ID of a control plane group
Remove Control Plane Group Members
Removes one or more control planes from the members of a control plane group.
post
Path Parameters
Body
application/json
Body
application/json
Request body for removing a list of child control planes from a control plane group membership.
GroupMembership
membersarray[object]required
Show Child Parameters
Response
Response
No Content
post/control-planes/{id}/group-memberships/remove
Authentication
Path Parameters
Body
{
"members": [
{
"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{
"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{
"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}
Control Plane Group Member Status
Determines the group membership status of a control plane.
get
Path Parameters
idstringrequired
ID of a control plane
Response
application/json
Response
application/json
Determines the group membership status of a control plane.
GroupMemberStatus
Object with information determining the group membership status of a control plane.
is_memberbooleanrequiredread-only
Boolean indicating if a control plane is a member of a control plane group.
Example:true
get/control-planes/{id}/group-member-status
Authentication
Path Parameters
application/json
Get Control Plane Group Status
Returns the status of a control plane group, including existing conflicts.
get
Path Parameters
idstringrequired
ID of a control plane group
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