Create Control Plane

Create a control plane in the Konnect Organization.

post

Body

application/json

CreateControlPlaneRequest

The request schema for the create control plane request.

* Additional properties are NOT allowed.
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.

cluster_typestring

The ClusterType value of the cluster associated with the Control Plane.

Allowed values:CLUSTER_TYPE_CONTROL_PLANECLUSTER_TYPE_K8S_INGRESS_CONTROLLERCLUSTER_TYPE_CONTROL_PLANE_GROUPCLUSTER_TYPE_SERVERLESSCLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXYCLUSTER_TYPE_CLOUD_API_GATEWAYCLUSTER_TYPE_SERVERLESS_V1

Example:CLUSTER_TYPE_CONTROL_PLANE

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

cloud_gatewayboolean

Whether this control-plane can be used for cloud-gateways.

Example:false

proxy_urlsarray[object](set)

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

Example:{"host":"example.com","port":443,"protocol":"https"}

* Additional properties are NOT allowed.
Show Child Parameters
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"}

Response

application/json

A response to creating a control plane.

ControlPlane

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

post/control-planes

Body

{ "name": "Test Control Plane", "description": "A test control plane for exploration.", "cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER", "cloud_gateway": false, "proxy_urls": [ { "host": "example.com", "port": 443, "protocol": "https" } ], "labels": { "env": "test" } }
 
application/json

Control Plane Resource Quotas

List Default Quotas

Returns a paginated collection of default resource quotas for control planes, along with
organizationally-defined overrides for those resource quotas.

get

Response

application/json

A response for listing default resource quota.

ListControlPlaneDefaultResourceQuotasResponse

dataarray[object]

Object containing information about a default resource quota, and any organizational overrides.

Show Child Parameters
get/control-planes/default-resource-quotas
 
application/json

List Quota Overrides

Returns a list of control plane quota override values created by the user.

get

Response

application/json

A response for listing all resource quotas for control plane.

dataarray[object]
Show Child Parameters
get/control-planes/resource-quotas
 
application/json

Create a control plane resource quota

Creates a control plane resource quota scoped to a given resource, for an organization.

post

Body

application/json

Request body for creating the control plane override resource quota value.

Quota override for a control plane

namestring

The human-readable name of this resource quota.

Example:Consumer

descriptionstring

A more verbose description of what this resource quota enforces.

Example:Across the organization, the aggregate number of consumers cannot exceed this value.

resourcestringrequired

Identifier value of resources available for quota enforcement.

Example:count/consumer

valueintegerrequired

The aggregate non-negative integer count of this resource that’s allowed for the organization.

>= 1

Example:5000

Response

application/json

A response for creating the control plane resource quota value.

Quota override for a control plane

idstring(uuid)read-only

The unique identifier for the resource quota.

namestring

The human-readable name of this resource quota.

Example:Consumer

descriptionstring

A more verbose description of what this resource quota enforces.

Example:Across the organization, the aggregate number of consumers cannot exceed this value.

resourcestringrequired

Identifier value of resources available for quota enforcement.

Example:count/consumer

valueintegerrequired

The aggregate non-negative integer count of this resource that’s allowed for the organization.

>= 1

Example:5000

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

post/control-planes/resource-quotas

Body

{ "name": "consumer override", "description": "Increase for consumer resource quota", "resource": "count/control-plane.consumer", "value": 40000 }
 
application/json