Skip to main content

Prerequisites

Authentication

The quota endpoints are served from https://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 keycreate a service account with the necessary permissions and generate a key.
  • User access token — log in with cpln login, then run cpln profile token <profile-name>.
Include the token in the Authorization header of every request:
In the examples below, replace 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:
The response is an array of quotas:

Browse the Quota Catalog

The catalog lists every quota that can exist, with its unit and description. Use it to find the exact quotaName to request an increase for:

Request a Quota Increase

Submit a request for a single quota and the new max you want. Provide the quotaName (from your current quotas or the catalog) and a requestedMax:
The response is the created request, including its id and status:
The status tells you what happened:
  • approved — the increase was granted. When autoApproved is true, it was granted automatically and the new max is applied to your org shortly after. A resolvedBy of system indicates an automatic approval.
  • pending — the request was larger than can be granted automatically and is awaiting review by the Control Plane team. Note the returned id so 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 its id to see its current status:
A 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 the org query parameter. Add an optional status filter (pending, approved, or denied):
The response is an array of the requests for your org.

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.