Add Composite RG Members
Adds one or more runtime groups as a member of a composite runtime group.
Path Parameters
ID of a composite runtime group
Body
application/json
Body
Request body for adding a list of child runtime groups to a composite runtime group membership.
Show Child Parameters
Response
Response
No Content
Authentication
Path Parameters
Body
Remove Composite RG Members
Removes one or more runtime groups from the members of a composite runtime group.
Path Parameters
ID of a composite runtime group
Body
application/json
Body
Request body for removing a list of child runtime groups from a composite runtime group membership.
Show Child Parameters
Response
Response
No Content
Authentication
Path Parameters
Body
Get Composite Membership Status
Determines the composite membership status of a runtime group.
Path Parameters
ID of a runtime group
Response
application/json
Response
Determines the composite membership status of a runtime group.
CompositeMemberStatus
Object with information determining the composite membership status of a runtime group.
Boolean indicating if a runtime group is a member of a composite runtime group.
Example:true
Authentication
Path Parameters
Get Composite RG Status
Returns the status of a composite runtime group, including existing conflicts.
Path Parameters
ID of a composite runtime group
Response
application/json
Response
Status of a composite runtime group, including existing conflicts.
CompositeStatus
The Composite Status object contains information about the status of a composite runtime group.
The composite runtime group ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8604 timestamp representation of composite runtime group status creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of composite runtime group status update date.
Example:2022-11-04T20:10:06.927Z
The Composite Conflict object contains information about a conflict in a composite runtime group.
<= 256 items
Show Child Parameters
The state of the composite runtime group.
Allowed values:COMPOSITE_STATE_OKCOMPOSITE_STATE_CONFLICTCOMPOSITE_STATE_UNKNOWN
Example:COMPOSITE_STATE_CONFLICT
Authentication
Path Parameters
CreateRuntimeGroupRequest
objectThe 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.
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"}