Get a Runtime Group
Returns information about a team from a given team ID.
Path Parameters
The runtime group ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
A response to retrieving a single runtime group.
RuntimeGroup
The runtime group object contains information about a Kong control plane.
The runtime group ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the runtime group.
Example:Test Runtime Group
The description of the runtime group in Konnect.
Example:A test runtime group for exploration.
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"}
CP configuration object for related access endpoints.
Show Child Parameters
An ISO-8604 timestamp representation of runtime group creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of runtime group update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Runtime Group
Update an individual runtime group.
Path Parameters
The runtime group ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
UpdateRuntimeGroupRequest
The request schema for the update runtime group request.
The name of the runtime group.
Example:Test Runtime Group
The description of the runtime group in Konnect.
Example:A test runtime group for exploration.
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
Proxy URL associated with reaching the data-planes connected to a runtime group.
Example:{"host":"example.com","port":443,"protocol":"https"}
Show Child Parameters
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
Response
A response to updating a runtime group.
RuntimeGroup
The runtime group object contains information about a Kong control plane.
The runtime group ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the runtime group.
Example:Test Runtime Group
The description of the runtime group in Konnect.
Example:A test runtime group for exploration.
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"}
CP configuration object for related access endpoints.
Show Child Parameters
An ISO-8604 timestamp representation of runtime group creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of runtime group update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete Runtime Group
Delete an individual runtime group.
Path Parameters
The runtime group ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Authentication
Path Parameters
Composite Runtime Groups
List Composite RG Memberships
Returns an array of runtime groups that are a member of this composite runtime group.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
ID of a composite runtime group
Response
application/json
Response
A paginated list response for a collection of composite runtime group memberships.
returns the pagination information
Show Child Parameters
The runtime group object contains information about a Kong control plane.