Runtime Groups
List Runtime Groups
Returns an array of runtime groups objects containing information about the Konnect Runtime Groups.
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
Filter by direct equality comparison of the name property with a supplied value.
Example:test
Filter by direct equality comparison (short-hand) of the name property with a supplied value.
Example:test
Filter by contains comparison of the name property with a supplied substring.
Example:test
Filter by non-equality comparison of the name property with a supplied value.
Example:test
Filter by direct equality comparison of the id property with a supplied value.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Filter by direct equality comparison (short-hand) of the id property with a supplied value.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Filter by direct equality comparison of id property with multiple supplied values.
Example:some-value,some-other-value
Filter by direct equality comparison of the cluster_type property with a supplied value.
Example:CLUSTER_TYPE_HYBRID
Filter by direct equality comparison (short-hand) of the cluster_type property with a supplied value.
Example:CLUSTER_TYPE_HYBRID
Filter by non-equality comparison of the cluster_type property with a supplied value.
Example:test
Filter runtime groups in the response by associated labels.
Example:key:value,existCheck
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
A paginated list response for a collection of runtime groups.
ListRuntimeGroupsResponse
returns the pagination information
Show Child Parameters
The runtime group object contains information about a Kong control plane.
Show Child Parameters
Authentication
Query Parameters
Create Runtime Group
Create a runtime group in the Konnect Organization.
Body
application/json
Body
CreateRuntimeGroupRequest
The request schema for the create 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 ClusterType value of the cluster associated with the Runtime Group.
Allowed values:CLUSTER_TYPE_HYBRIDCLUSTER_TYPE_K8S_INGRESS_CONTROLLERCLUSTER_TYPE_COMPOSITECLUSTER_TYPE_SERVERLESSCLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXYCLUSTER_TYPE_SERVERLESS_V1
Example:CLUSTER_TYPE_HYBRID
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
Whether this runtime group can be used for cloud-gateways.
Example:false
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 creating 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
Body
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