Create Runtime Group

Create a runtime group in the Konnect Organization.

post

Body

application/json

CreateRuntimeGroupRequest

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_CLOUD_API_GATEWAYCLUSTER_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.

Example:false

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

Response

application/json

A response to creating a runtime group.

RuntimeGroup

The runtime group object contains information about a Kong control plane.

* Additional properties are NOT allowed.
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"}{"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

post/runtime-groups

Body

{ "name": "Test Runtime Group", "description": "A test runtime group for exploration.", "cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER", "cloud_gateway": false, "proxy_urls": [ { "host": "example.com", "port": 443, "protocol": "https" } ], "labels": { "test": "true" } }
 
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_CLOUD_API_GATEWAYCLUSTER_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

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

RuntimeGroupSummary

object

The runtime group object contains information about a Kong control plane.

* Additional properties are NOT allowed.
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)
updated_atstring(date-time)
Example

Labels

object

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