Get a Runtime Group

Returns information about a team from a given team ID.

get

Path Parameters

idstring(uuid)required

The runtime group ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

A response to retrieving a single runtime group.

RuntimeGroup

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

* Additional properties are NOT allowed.
idstring(uuid)read-only

The runtime group ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The name of the runtime group.

Example:Test Runtime Group

descriptionstring

The description of the runtime group in Konnect.

Example:A test runtime group for exploration.

labelsobject

Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"test":"true"}{"test":"true"}

configobject

CP configuration object for related access endpoints.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group update date.

Example:2022-11-04T20:10:06.927Z

get/runtime-groups/{id}
 
application/json

Update Runtime Group

Update an individual runtime group.

patch

Path Parameters

idstring(uuid)required

The runtime group ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

UpdateRuntimeGroupRequest

The request schema for the update runtime group request.

* Additional properties are NOT allowed.
namestring

The name of the runtime group.

Example:Test Runtime Group

descriptionstring

The description of the runtime group in Konnect.

Example:A test runtime group 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]

Proxy URL associated with reaching the data-planes connected to a runtime group.

Example:{"host":"example.com","port":443,"protocol":"https"}

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"test":"true"}

Response

application/json

A response to updating a runtime group.

RuntimeGroup

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

* Additional properties are NOT allowed.
idstring(uuid)read-only

The runtime group ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The name of the runtime group.

Example:Test Runtime Group

descriptionstring

The description of the runtime group in Konnect.

Example:A test runtime group for exploration.

labelsobject

Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"test":"true"}{"test":"true"}

configobject

CP configuration object for related access endpoints.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group update date.

Example:2022-11-04T20:10:06.927Z

patch/runtime-groups/{id}

Body

{ "name": "Test Runtime Group", "description": "A test runtime group for exploration.", "labels": { "otherTest": "true" } }
 
application/json

Delete Runtime Group

Delete an individual runtime group.

delete

Path Parameters

idstring(uuid)required

The runtime group ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

No Content

delete/runtime-groups/{id}
 

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