Search
K
Konnect Control Planes

ControlPlane

object

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

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The control plane ID.

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

namestringrequired

The name of the control plane.

Example:Test Control Plane

descriptionstring

The description of the control plane in Konnect.

Example:A test control plane for exploration.

labelsobject

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"env":"test"}

configobjectrequired

CP configuration object for related access endpoints.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of control plane creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of control plane update date.

Example:2022-11-04T20:10:06.927Z

Example

GroupStatus

object

The Group Status object contains information about the status of a control plane group.

idstring(uuid)requiredread-only

The control plane group ID.

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

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of control plane group status creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of control plane group status update date.

Example:2022-11-04T20:10:06.927Z

conflictsarray[object]

The Group Conflict object contains information about a conflict in a control plane group.

<= 256 items

Show Child Parameters
statestringrequiredread-only

The state of the control plane group.

Allowed values:OKCONFLICTUNKNOWN

Example:CONFLICT

Example

GroupConflict

object

The Group Conflict object contains information about a conflict in a control plane group.

cluster_idstring(uuid)requiredread-only

The ID of a control plane member of a control plane group.

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

descriptionstringrequiredread-only

The description of the conflict.

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

resourceobjectrequired

A resource causing a conflict in a control plane group.

Show Child Parameters
Example

GroupConflictResource

object

A resource causing a conflict in a control plane group.

idstring(uuid)requiredread-only

The ID of the resource.

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

typestringrequiredread-only

The type of the resource.

Example:service

Example

GroupMemberStatus

object

Object with information determining the group membership status of a control plane.

is_memberbooleanrequiredread-only

Boolean indicating if a control plane is a member of a control plane group.

Example:true

Example