Control Plane Groups
List Control Plane Group Memberships
Returns an array of control planes that are a member of this control plane group.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[after]string
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
idstringrequired
ID of a control plane group
Response
application/json
Response
application/json
A paginated list response for a collection of control plane group memberships.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
The control plane object contains information about a Kong control plane.
* Additional properties are NOT allowed.
Show Child Parameters
get/control-planes/{id}/group-memberships
Authentication
Path Parameters
Query Parameters
application/json
Upsert Control Plane Group Members
Adds one or more control planes as a member of a control plane group.
put
Path Parameters
idstringrequired
ID of a control plane group
Body
application/json
Body
application/json
Request body for upserting a list of child control planes to a control plane group membership.
GroupMembership
membersarray[object]required
Show Child Parameters
Response
Response
No Content
put/control-planes/{id}/group-memberships
Authentication
Path Parameters
Body
{
"members": [
{
"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{
"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{
"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}
Add Control Plane Group Members
Adds one or more control planes as a member of a control plane group.
post
Path Parameters
idstringrequired
ID of a control plane group
Body
application/json
Body
application/json
Request body for adding a list of child control planes to a control plane group membership.
GroupMembership
membersarray[object]required
Show Child Parameters
Response
Response
No Content
post/control-planes/{id}/group-memberships/add
Authentication
Path Parameters
Body
{
"members": [
{
"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{
"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{
"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}
Remove Control Plane Group Members
Removes one or more control planes from the members of a control plane group.
post
Path Parameters
idstringrequired
ID of a control plane group
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"
}
]
}