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

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example