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

ProxyURL

object

Proxy URL associated with reaching the data-planes connected to a runtime group.

* Additional properties are NOT allowed.
hoststringrequired

Hostname of the proxy URL.

portintegerrequired

Port of the proxy URL.

protocolstringrequired

Protocol of the proxy URL.

Example

ProxyURLs

array

Array of proxy URLs associated with reaching the data-planes connected to a runtime group.

hoststringrequired

Hostname of the proxy URL.

portintegerrequired

Port of the proxy URL.

protocolstringrequired

Protocol of the proxy URL.

Example