Search
K
Konnect Control Planes

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

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

ControlPlaneFilterParameters

object
* Additional properties are NOT allowed.
idOne Of
StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
nameOne Of
StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
cluster_typeOne Of
StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
cloud_gatewayboolean

Filter by a boolean value (true/false).

Example