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

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

CompositeStatus

object

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

Example

CompositeConflict

object

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

cluster_idstring(uuid)read-only

The ID of a runtime group member of a composite runtime group.

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

descriptionstringread-only

The description of the conflict.

Example:conflicting entity found: ID=38d790ad-8b08-4ff5-a074-2e1e9e64d8bd, Name=foo

resourceobject

A resource causing a conflict in a composite runtime group.

Show Child Parameters
Example