Get Composite Membership Status

Determines the composite membership status of a runtime group.

get

Path Parameters

idstringrequired

ID of a runtime group

Response

application/json

Determines the composite membership status of a runtime group.

CompositeMemberStatus

Object with information determining the composite membership status of a runtime group.

is_memberbooleanrequiredread-only

Boolean indicating if a runtime group is a member of a composite runtime group.

Example:true

get/runtime-groups/{id}/composite-member-status
 
application/json

Get Composite RG Status

Returns the status of a composite runtime group, including existing conflicts.

get

Path Parameters

idstringrequired

ID of a composite runtime group

Response

application/json

Status of a composite runtime group, including existing conflicts.

CompositeStatus

The Composite Status object contains information about the status of a composite runtime group.

idstring(uuid)read-only

The composite runtime group ID.

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

created_atstring(date-time)read-only

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

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

updated_atstring(date-time)read-only

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

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

conflictsarray[object]

The Composite Conflict object contains information about a conflict in a composite runtime group.

<= 256 items

Show Child Parameters
statestringread-only

The state of the composite runtime group.

Allowed values:COMPOSITE_STATE_OKCOMPOSITE_STATE_CONFLICTCOMPOSITE_STATE_UNKNOWN

Example:COMPOSITE_STATE_CONFLICT

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

CreateRuntimeGroupRequest

object

The request schema for the create runtime group request.

* Additional properties are NOT allowed.
namestringrequired

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.

cluster_typestring

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

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

cloud_gatewayboolean

Whether this runtime group can be used for cloud-gateways.

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"}

Example

UpdateRuntimeGroupRequest

object

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"}

Example

RuntimeGroup

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"}

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

Example