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

Labels

object

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

ProxyURL

object

Proxy URL associated with reaching the data-planes connected to a control-plane.

* 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 control-plane.

hoststringrequired

Hostname of the proxy URL.

portintegerrequired

Port of the proxy URL.

protocolstringrequired

Protocol of the proxy URL.

Example

ControlPlaneResourceQuotaName

string

The human-readable name of this resource quota.

Example