---
title: "Konnect Control Planes"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-internal-2/versions/6d98ada9-c239-4df7-9d85-7fec86ef3f12"
---

# Konnect Control Planes

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect Control Planes","version":"2.0.0","description":"The API for Kong Konnect Control Planes.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v2","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v2","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v2","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v2","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v2","description":"India Production region"},{"url":"https://sg.api.konghq.com/v2","description":"Singapore Production region"}],"paths":{"/control-planes":{"post":{"operationId":"create-control-plane","summary":"Create Control Plane","description":"Create a control plane in the Konnect Organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateControlPlaneRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/CreateControlPlaneRequestExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateControlPlaneResponse"},"400":{"$ref":"#/components/responses/ControlPlanesBadRequest"},"401":{"$ref":"#/components/responses/ControlPlaneUnauthenticated"},"403":{"$ref":"#/components/responses/ControlPlanePermissionDenied"},"409":{"$ref":"#/components/responses/ControlPlaneConflict"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"tags":["Control Planes"]}},"/control-planes/default-resource-quotas":{"get":{"operationId":"list-control-plane-default-resource-quotas","summary":"List Default Quotas","description":"Returns a paginated collection of default resource quotas for control planes, along with\norganizationally-defined overrides for those resource quotas.\n","responses":{"200":{"$ref":"#/components/responses/ListControlPlaneDefaultResourceQuotasResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Control Plane Resource Quotas"]}},"/control-planes/resource-quotas":{"get":{"operationId":"list-control-plane-resource-quota","summary":"List Quota Overrides","description":"Returns a list of control plane quota override values created by the user.\n","responses":{"200":{"$ref":"#/components/responses/ListControlPlaneResourceQuotasResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Control Plane Resource Quotas"]},"post":{"operationId":"create-control-plane-resource-quota","summary":"Create a control plane resource quota","description":"Creates a control plane resource quota scoped to a given resource, for an organization.\n","requestBody":{"$ref":"#/components/requestBodies/CreateControlPlaneResourceQuotaRequest"},"responses":{"201":{"$ref":"#/components/responses/CreateControlPlaneResourceQuotaResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Control Plane Resource Quotas"]}},"/control-planes/resource-quotas/{resourceQuotaId}":{"parameters":[{"$ref":"#/components/parameters/ResourceQuotaID"}],"get":{"operationId":"get-control-plane-resource-quota","summary":"Get Control Plane Resource Quota","description":"Returns the control plane resource quota for the ID.\n","responses":{"200":{"$ref":"#/components/responses/GetControlPlaneResourceQuotaResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Control Plane Resource Quotas"]},"patch":{"operationId":"update-control-plane-resource-quota","summary":"Update Resource Quota","description":"Update the control plane resource quota for the corresponding ID.","requestBody":{"$ref":"#/components/requestBodies/UpdateControlPlaneResourceQuotaRequest"},"responses":{"200":{"$ref":"#/components/responses/UpdateControlPlaneResourceQuotaResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Control Plane Resource Quotas"]},"delete":{"operationId":"delete-control-plane-resource-quota","summary":"Delete the control plane resource quota","description":"Deletes the created control plane resource quota which matches the ID provided.\n","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["Control Plane Resource Quotas"]}}},"components":{"parameters":{"ResourceQuotaID":{"name":"resourceQuotaId","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"description":"The UUID for the control plane resource quota."}},"schemas":{"CreateControlPlaneRequest":{"description":"The request schema for the create control plane request.","type":"object","properties":{"name":{"description":"The name of the control plane.","type":"string","example":"Test Control Plane"},"description":{"description":"The description of the control plane in Konnect.","type":"string","example":"A test control plane for exploration.","nullable":false},"cluster_type":{"description":"The ClusterType value of the cluster associated with the Control Plane.","type":"string","example":"CLUSTER_TYPE_CONTROL_PLANE","enum":["CLUSTER_TYPE_CONTROL_PLANE","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_CONTROL_PLANE_GROUP","CLUSTER_TYPE_SERVERLESS","CLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXY","CLUSTER_TYPE_CLOUD_API_GATEWAY","CLUSTER_TYPE_SERVERLESS_V1"]},"auth_type":{"description":"The auth type value of the cluster associated with the Runtime Group.","type":"string","example":"pinned_client_certs","enum":["pinned_client_certs","pki_client_certs"]},"cloud_gateway":{"description":"Whether this control-plane can be used for cloud-gateways.","type":"boolean","example":false,"nullable":false},"proxy_urls":{"$ref":"#/components/schemas/ProxyURLs"},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name"],"title":"CreateControlPlaneRequest"},"ControlPlane":{"description":"The control plane object contains information about a Kong control plane.","type":"object","properties":{"id":{"description":"The control plane ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The name of the control plane.","type":"string","example":"Test Control Plane"},"description":{"description":"The description of the control plane in Konnect.","type":"string","example":"A test control plane for exploration.","nullable":false},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"description":"CP configuration object for related access endpoints.","type":"object","additionalProperties":false,"properties":{"control_plane_endpoint":{"description":"Control Plane Endpoint.","type":"string","format":"url","example":"https://acfe5f253f.cp.konghq.com","readOnly":true},"telemetry_endpoint":{"description":"Telemetry Endpoint.","type":"string","format":"url","example":"https://acfe5f253f.tp0.konghq.com","readOnly":true},"cluster_type":{"description":"The ClusterType value of the cluster associated with the Control Plane.","type":"string","example":"CLUSTER_TYPE_CONTROL_PLANE","enum":["CLUSTER_TYPE_CONTROL_PLANE","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_CONTROL_PLANE_GROUP","CLUSTER_TYPE_SERVERLESS","CLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXY","CLUSTER_TYPE_CLOUD_API_GATEWAY","CLUSTER_TYPE_SERVERLESS_V1"],"readOnly":true},"auth_type":{"description":"The auth type value of the cluster associated with the Runtime Group.","type":"string","example":"pinned_client_certs","enum":["pinned_client_certs","pki_client_certs"],"readOnly":true},"cloud_gateway":{"description":"Whether the Control Plane can be used for cloud-gateways.","type":"boolean","nullable":false,"readOnly":true},"proxy_urls":{"$ref":"#/components/schemas/ProxyURLs"}},"required":["control_plane_endpoint","telemetry_endpoint","cluster_type","auth_type","cloud_gateway"]},"created_at":{"description":"An ISO-8604 timestamp representation of control plane creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"updated_at":{"description":"An ISO-8604 timestamp representation of control plane update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"additionalProperties":false,"required":["id","name","config","created_at","updated_at"],"x-examples":{"Example 1":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Test Control Plane","description":"A test control plane for exploration.","labels":{"env":"test"},"config":{"control_plane_endpoint":"https://acfe5f253f.cp.konghq.com","telemetry_endpoint":"https://acfe5f253f.tp0.konghq.com","cluster_type":"CLUSTER_TYPE_CONTROL_PLANE","auth_type":"pinned_client_certs","cloud_gateway":false,"proxy_urls":[{"host":"example.com","port":443,"protocol":"https"}]},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}}},"Labels":{"description":"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 '_'.","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z\\-\\.\\_]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"title":"Labels"},"ProxyURL":{"description":"Proxy URL associated with reaching the data-planes connected to a control-plane.","type":"object","properties":{"host":{"description":"Hostname of the proxy URL.","type":"string"},"port":{"description":"Port of the proxy URL.","type":"integer"},"protocol":{"description":"Protocol of the proxy URL.","type":"string"}},"example":{"host":"example.com","port":443,"protocol":"https"},"additionalProperties":false,"required":["host","port","protocol"],"title":"ProxyURL"},"ProxyURLs":{"description":"Array of proxy URLs associated with reaching the data-planes connected to a control-plane.","type":"array","items":{"$ref":"#/components/schemas/ProxyURL"},"format":"set","example":[{"host":"example.com","port":443,"protocol":"https"}],"title":"ProxyURLs"},"ControlPlaneResourceQuotaName":{"description":"The human-readable name of this resource quota.","type":"string","example":"Consumer"},"ControlPlaneResourceQuotaResourceName":{"description":"Identifier value of resources available for quota enforcement.","type":"string","example":"count/consumer"},"ControlPlaneResourceQuotaDescription":{"description":"A more verbose description of what this resource quota enforces.","type":"string","example":"Across the organization, the aggregate number of consumers cannot exceed this value."},"ControlPlaneResourceQuotaValue":{"description":"The aggregate non-negative integer count of this resource that's allowed for the organization.\n","type":"integer","example":5000,"minimum":1},"PatchControlPlaneResourceQuota":{"description":"Request schema for patching a resource quota for an organization.","type":"object","properties":{"value":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaValue"}},"additionalProperties":false,"required":["value"]},"ControlPlaneResourceQuota":{"type":"object","properties":{"id":{"description":"The unique identifier for the resource quota.","type":"string","format":"uuid","readOnly":true},"name":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaName"},"description":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaDescription"},"resource":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaResourceName"},"value":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaValue"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["resource","value"],"title":"Quota override for a control plane"},"ControlPlaneDefaultResourceQuota":{"description":"Object containing information about a default resource quota, and any organizational overrides.","type":"object","properties":{"id":{"description":"The unique identifier for the default quota.","type":"string","readOnly":true},"name":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaName"},"description":{"$ref":"#/components/schemas/ControlPlaneResourceQuotaDescription"},"resource":{"description":"The resource name under a control plane.","type":"string"},"value":{"description":"The resource quota value for the corresponding resource.","type":"integer"},"overrides":{"description":"Organizational overrides for this default resource quota.","type":"array","items":{"$ref":"#/components/schemas/ControlPlaneResourceQuota"}}},"required":["id","name","description","resource","value"],"title":"Default Resource Quota"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true}},"examples":{"400RequestFormatInvalidExample":{"value":{"status":400,"title":"Bad Request","detail":"Invalid request format","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"body","reason":"request format is invalid"}]}},"400CannotBeBlankExample":{"value":{"status":400,"title":"Bad Request","detail":"Request cannot be empty","instance":"konnect:trace:6644808935508571943","invalid_parameters":[{"field":"name","reason":"cannot be blank"}]}},"400InvalidIDFormatExample":{"value":{"status":400,"title":"Bad Request","detail":"Request contains invalid ID format","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"id","reason":"invalid ID format"}]}},"400UsageLimitsReachedExample":{"value":{"status":400,"title":"Bad Request","instance":"konnect:trace:8988732526256293040","detail":"Cannot create an additional control plane because usage limits have been reached.","invalid_parameters":[{"field":"object","reason":"usage limits reached"}]}},"400UnknownPropertyExample":{"value":{"status":400,"title":"Bad Request","detail":"Request contains unknown property","instance":"konnect:trace:8988732526256293040","invalid_parameters":[{"field":"id","reason":"property id should not exist"}]}},"401UnauthenticatedExample":{"value":{"status":401,"title":"Unauthenticated","instance":"konnect:trace:952172606039454040","detail":"A valid token is required"}},"403PermissionDeniedExample":{"value":{"status":403,"title":"Permission denied","instance":"konnect:trace:2822394689570210664","detail":"Insufficient role-set to create control planes."}},"409ConflictExample":{"value":{"status":409,"title":"Conflict","instance":"konnect:trace:2287285207635123011","detail":"Control Plane with provided name already exists."}},"500InternalErrorExample":{"value":{"status":500,"title":"Internal Server Error","instance":"konnect:trace:2287285207635123011","detail":"Could not propagate control plane changes to control plane cluster service."}},"503PermissionReadFailureExample":{"value":{"status":503,"title":"Service Unavailable","instance":"konnect:trace:2287285207635123011","detail":"Could not retrieve permissions to check resource accessibility."}},"CreateControlPlaneRequestExample":{"value":{"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"}}},"ControlPlaneExample":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"Test Control Plane","description":"A test control plane for exploration.","labels":{"env":"test"},"config":{"control_plane_endpoint":"https://acfe5f253f.cp.konghq.com","telemetry_endpoint":"https://acfe5f253f.tp0.konghq.com","cluster_type":"CLUSTER_TYPE_CONTROL_PLANE","auth_type":"pinned_client_certs","cloud_gateway":false,"proxy_urls":[{"host":"example.com","port":443,"protocol":"https"}]},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"ListControlPlaneDefaultResourceQuotaExample":{"value":{"data":[{"id":"cc504063-f3bb-4e09-8e32-bbcdbc5cd618","name":"consumer","description":"Default value of the consumer resource","resource":"count/control-plane.consumer","value":10000,"overrides":[{"id":"7cdad5ef-1738-4781-8d71-9c5bbc99b187","name":"consumer override","description":"Increase for consumer resource quota","resource":"count/control-plane.consumer","value":50000,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}]},{"id":"1beb9ad3-f3bb-4e09-8e32-bbcdbc5cd618","name":"certificate","description":"Default value of the route resource","resource":"count/control-plane.route","value":500}]}},"ListControlPlaneResourceQuotaExample":{"value":{"data":[{"id":"7cdad5ef-1738-4781-8d71-9c5bbc99b187","name":"consumer override","description":"Increase for consumer resource quota","resource":"count/control-plane.consumer","value":50000,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"cbef8c44-0fb1-4cb6-979c-5b82d2334b5f","name":"route override","description":"Override for resource route","resource":"count/control-plane.route","value":1000,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}]}},"ControlPlaneQuotaExample":{"value":{"id":"7cdad5ef-1738-4781-8d71-9c5bbc99b187","name":"consumer override","description":"Increase for consumer resource quota","resource":"count/control-plane.consumer","value":50000,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"UpdateControlPlaneResourceQuotaRequestExample":{"value":{"value":50000}},"CreateControlPlaneResourceQuotaRequestExample":{"value":{"name":"consumer override","description":"Increase for consumer resource quota","resource":"count/control-plane.consumer","value":40000}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"UpdateControlPlaneResourceQuotaRequest":{"required":true,"description":"Request body for updating the control plane override resource quota value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchControlPlaneResourceQuota"},"examples":{"UpdateControlPlaneResourceQuotaRequestExample":{"$ref":"#/components/examples/UpdateControlPlaneResourceQuotaRequestExample"}}}}},"CreateControlPlaneResourceQuotaRequest":{"required":true,"description":"Request body for creating the control plane override resource quota value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlaneResourceQuota"},"examples":{"CreateControlPlaneResourceQuotaRequestExample":{"$ref":"#/components/examples/CreateControlPlaneResourceQuotaRequestExample"}}}}}},"responses":{"CreateControlPlaneResponse":{"description":"A response to creating a control plane.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlane"},"examples":{"Create Control Plane Response":{"$ref":"#/components/examples/ControlPlaneExample"}}}}},"ControlPlanesBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Request Format Invalid":{"$ref":"#/components/examples/400RequestFormatInvalidExample"},"Cannot Be Blank":{"$ref":"#/components/examples/400CannotBeBlankExample"},"Invalid ID Format":{"$ref":"#/components/examples/400InvalidIDFormatExample"},"Usage Limits Reached":{"$ref":"#/components/examples/400UsageLimitsReachedExample"},"Unknown Property":{"$ref":"#/components/examples/400UnknownPropertyExample"}}}}},"ControlPlanePermissionDenied":{"description":"Permission denied","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"Permission Denied":{"$ref":"#/components/examples/403PermissionDeniedExample"}}}}},"ControlPlaneUnauthenticated":{"description":"Unauthenticated","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"Unauthorized":{"$ref":"#/components/examples/401UnauthenticatedExample"}}}}},"ControlPlaneConflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"},"examples":{"Conflict":{"$ref":"#/components/examples/409ConflictExample"}}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/problem+json":{"schema":{"description":"The error response object.","type":"object","properties":{"status":{"description":"The HTTP status code.","type":"integer","format":"int32","example":500,"enum":[500],"x-go-type":"int32"},"title":{"description":"The error response code.","type":"string","example":"Internal Server Error"},"instance":{"description":"The Konnect traceback code","type":"string","example":"konnect:trace:2287285207635123011"},"detail":{"description":"Details about the error.","type":"string","example":"Could not propagate control plane changes to control plane cluster service."}},"required":["status","title","instance"],"title":"InternalServerError"},"examples":{"Internal Server Error":{"$ref":"#/components/examples/500InternalErrorExample"}}}}},"ServiceUnavailable":{"description":"Service Unavailable","content":{"application/problem+json":{"schema":{"description":"Error response for temporary service unavailability.","type":"object","properties":{"status":{"description":"The HTTP status code.","type":"integer","format":"int32","example":503,"enum":[503],"x-go-type":"int32"},"title":{"description":"The error response code.","type":"string","example":"Service Unavailable"},"instance":{"description":"The Konnect traceback code","type":"string","example":"konnect:trace:2287285207635123011"},"detail":{"description":"Details about the error.","type":"string","example":"Could not retrieve permissions to check resource accessibility."}},"required":["status","title","instance"],"title":"ServiceUnavailableError"},"examples":{"Service Unavailable":{"$ref":"#/components/examples/503PermissionReadFailureExample"}}}}},"ListControlPlaneDefaultResourceQuotasResponse":{"description":"A response for listing default resource quota.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ControlPlaneDefaultResourceQuota"}}},"readOnly":true,"title":"ListControlPlaneDefaultResourceQuotasResponse"},"examples":{"ListControlPlaneDefaultQuotaResponseExample":{"$ref":"#/components/examples/ListControlPlaneDefaultResourceQuotaExample"}}}}},"ListControlPlaneResourceQuotasResponse":{"description":"A response for listing all resource quotas for control plane.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ControlPlaneResourceQuota"}}},"readOnly":true},"examples":{"ListControlPlaneResourceQuotasResponseExample":{"$ref":"#/components/examples/ListControlPlaneResourceQuotaExample"}}}}},"GetControlPlaneResourceQuotaResponse":{"description":"A response for getting the control plane resource quota value corresponding to resource or id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlaneResourceQuota"},"examples":{"GetControlPlaneResourceQuotaResponseExample":{"$ref":"#/components/examples/ControlPlaneQuotaExample"}}}}},"CreateControlPlaneResourceQuotaResponse":{"description":"A response for creating the control plane resource quota value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlaneResourceQuota"},"examples":{"CreateControlPlaneResourceQuotaResponseExample":{"$ref":"#/components/examples/ControlPlaneQuotaExample"}}}}},"UpdateControlPlaneResourceQuotaResponse":{"description":"A response for updating the control plane resource quota value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlaneResourceQuota"},"examples":{"UpdateControlPlaneResourceQuotaResponseExample":{"$ref":"#/components/examples/ControlPlaneQuotaExample"}}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Control Planes"},{"name":"Control Plane Resource Quotas"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
