Prerequisites
- Review the Quotas concept page and the Quota reference.
- Have the org-level
viewpermission for the org whose quotas you are managing. (Browsing the quota catalog requires only a valid token, since it is not org-specific.) - An authorization token (see Authentication).
Authentication
The quota endpoints are served fromhttps://billing-ng.cpln.io and use the same Bearer token authentication as the rest of the Control Plane API.
Obtain a token using either method:
- Service account key — create a service account with the necessary permissions and generate a key.
- User access token — log in with
cpln login, then runcpln profile token <profile-name>.
Authorization header of every request:
YOUR_TOKEN_HERE with your token and my-org with your org name.
View Your Current Quotas
List every quota on your org, including its current usage and allowed maximum:Browse the Quota Catalog
The catalog lists every quota that can exist, with its unit and description. Use it to find the exactquotaName to request an increase for:
Request a Quota Increase
Submit a request for a single quota and the new max you want. Provide thequotaName (from your current quotas or the catalog) and a requestedMax:
id and status:
status tells you what happened:
approved— the increase was granted. WhenautoApprovedistrue, it was granted automatically and the new max is applied to your org shortly after. AresolvedByofsystemindicates an automatic approval.pending— the request was larger than can be granted automatically and is awaiting review by the Control Plane team. Note the returnedidso you can check its status later.
A quota increase request only ever raises a limit. A request for a value at or below your current max is treated as already satisfied and leaves the quota unchanged.
Check the Status of a Request
Retrieve a request by itsid to see its current status:
pending request becomes approved or denied once it has been reviewed. After a request is approved, the new max appears on the quota when you view your current quotas.
List Your Org’s Requests
To see all increase requests for your org, list them with theorg query parameter. Add an optional status filter (pending, approved, or denied):
Next Steps
- Learn how quotas and increase requests work in the Quotas concept page.
- See the Quota reference for the list of quota resources and their permissions.