Get Control Plane Resource Quota
Returns the control plane resource quota for the ID.
Path Parameters
The UUID for the control plane resource quota.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A response for getting the control plane resource quota value corresponding to resource or id.
Quota override for a control plane
The unique identifier for the resource quota.
The human-readable name of this resource quota.
Example:Consumer
A more verbose description of what this resource quota enforces.
Example:Across the organization, the aggregate number of consumers cannot exceed this value.
Identifier value of resources available for quota enforcement.
Example:count/consumer
The aggregate non-negative integer count of this resource that’s allowed for the organization.
>= 1
Example:5000
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Resource Quota
Update the control plane resource quota for the corresponding ID.
Path Parameters
The UUID for the control plane resource quota.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
Request body for updating the control plane override resource quota value.
PatchControlPlaneResourceQuota
Request schema for patching a resource quota for an organization.
The aggregate non-negative integer count of this resource that’s allowed for the organization.
>= 1
Example:5000
Response
application/json
Response
A response for updating the control plane resource quota value.
Quota override for a control plane
The unique identifier for the resource quota.
The human-readable name of this resource quota.
Example:Consumer
A more verbose description of what this resource quota enforces.
Example:Across the organization, the aggregate number of consumers cannot exceed this value.
Identifier value of resources available for quota enforcement.
Example:count/consumer
The aggregate non-negative integer count of this resource that’s allowed for the organization.
>= 1
Example:5000
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete the control plane resource quota
Deletes the created control plane resource quota which matches the ID provided.
Path Parameters
The UUID for the control plane resource quota.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
No Content
Authentication
Path Parameters
CreateControlPlaneRequest
objectThe request schema for the create 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 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
The auth type value of the cluster associated with the Runtime Group.
Allowed values:pinned_client_certspki_client_certs
Example:pinned_client_certs
Whether this control-plane can be used for cloud-gateways.
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