Composite Runtime Groups

List Composite RG Memberships

Returns an array of runtime groups that are a member of this composite runtime 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[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

idstringrequired

ID of a composite runtime group

Response

application/json

A paginated list response for a collection of composite runtime group memberships.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

The runtime group object contains information about a Kong control plane.

* Additional properties are NOT allowed.
Show Child Parameters
get/runtime-groups/{id}/composite-memberships
 
application/json

Upsert Composite RG Members

Upserts runtime groups as a member of a composite runtime group.

put

Path Parameters

idstringrequired

ID of a composite runtime group

Body

application/json

Request body for upserting a list of child runtime groups to a composite runtime group membership.

membersarray[object]
Show Child Parameters

Response

No Content

put/runtime-groups/{id}/composite-memberships

Body

{ "members": [ { "id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }, { "id": "778a0474-687d-41af-8e51-a0488d790586" }, { "id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459" } ] }
 

Add Composite RG Members

Adds one or more runtime groups as a member of a composite runtime group.

post

Path Parameters

idstringrequired

ID of a composite runtime group

Body

application/json

Request body for adding a list of child runtime groups to a composite runtime group membership.

membersarray[object]
Show Child Parameters

Response

No Content

post/runtime-groups/{id}/composite-memberships/add

Body

{ "members": [ { "id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }, { "id": "778a0474-687d-41af-8e51-a0488d790586" }, { "id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459" } ] }
 

Remove Composite RG Members

Removes one or more runtime groups from the members of a composite runtime group.

post

Path Parameters

idstringrequired

ID of a composite runtime group

Body

application/json

Request body for removing a list of child runtime groups from a composite runtime group membership.

membersarray[object]
Show Child Parameters

Response

No Content

post/runtime-groups/{id}/composite-memberships/remove

Body

{ "members": [ { "id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }, { "id": "778a0474-687d-41af-8e51-a0488d790586" }, { "id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459" } ] }