Runtime Groups
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_HTTP_GATEWAYCLUSTER_TYPE_EVENT_GATEWAYCLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXYCLUSTER_TYPE_CLOUD_API_GATEWAYCLUSTER_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
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_HTTP_GATEWAYCLUSTER_TYPE_EVENT_GATEWAYCLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXYCLUSTER_TYPE_CLOUD_API_GATEWAYCLUSTER_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"}
RuntimeGroup
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"}
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
RuntimeGroupSummary
objectThe 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"}
CP configuration object for related access endpoints.