UpdateControlPlaneRequest
objectThe request schema for the update control plane request.
The name of the control plane.
Example:Test Control Plane
The description of the control plane in Konnect.
Example:A test control plane for exploration.
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
Proxy URL associated with reaching the data-planes connected to a control-plane.
Example:{"host":"example.com","port":443,"protocol":"https"}
Show Child Parameters
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"}
ControlPlane
objectThe control plane object contains information about a Kong control plane.
The control plane ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the control plane.
Example:Test Control Plane
The description of the control plane in Konnect.
Example:A test control plane for exploration.
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"}
CP configuration object for related access endpoints.
Show Child Parameters
An ISO-8604 timestamp representation of control plane creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of control plane update date.
Example:2022-11-04T20:10:06.927Z
GroupStatus
objectThe Group Status object contains information about the status of a control plane group.
The control plane group ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8604 timestamp representation of control plane group status creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of control plane group status update date.
Example:2022-11-04T20:10:06.927Z
The Group Conflict object contains information about a conflict in a control plane group.
<= 256 items
Show Child Parameters
The state of the control plane group.
Allowed values:OKCONFLICTUNKNOWN
Example:CONFLICT
GroupConflict
objectThe Group Conflict object contains information about a conflict in a control plane group.
The ID of a control plane member of a control plane group.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The description of the conflict.
Example:conflicting entity found: ID=38d790ad-8b08-4ff5-a074-2e1e9e64d8bd, Name=foo
A resource causing a conflict in a control plane group.
Show Child Parameters
GroupConflictResource
objectA resource causing a conflict in a control plane group.
The ID of the resource.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The type of the resource.
Example:service