Get organization quotas | ClickHouse Docs

GET/v1/organizations/{organizationId}/quotas

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns the resource quotas enforced for the organization together with their current usage where available. Quotas that do not apply to the organization are omitted. Quota values reflect the limits currently enforced, so they can be polled to detect changes, for example after a billing status change. The response contains one entry per quota code; quotas enforced per resource may additionally appear under resource-scoped endpoints in the future.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the requested organization.

format: uuid

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalarray ofobject
7 properties
- quotaCodeservices-per-organizationorpostgres-services-per-organizationorreplicas-per-warehouseorapi-keys-per-organizationrequired
  Stable identifier of the quota. Use it to request a single quota by code.
  
  Example: "services-per-organization"
- namestringrequired
  Human-readable name of the quota.
  
  Example: "Services per organization"
- descriptionstringrequired
  Explanation of the resource the quota limits and how the limit is applied.
- scopeorganizationorwarehouserequired
  Granularity at which the limit is applied. For example, replicas-per-warehouse is an organization-wide setting that limits each warehouse individually.
  
  Example: "organization"
- valueintegerrequired
  Limit currently applied to the organization, including any adjustments made for the organization. The value can change when the billing status of the organization changes.
  
  minimum: 0
  Example: 20
- adjustablebooleanrequired
  Whether the limit can be raised for the organization by contacting ClickHouse support.
- usageoptionalinteger
  Current consumption of the quota. Omitted for quotas that do not report usage. Usage can exceed value when a limit was lowered after resources were created; existing resources are not affected.
  
  minimum: 0
  Example: 3

Get organization quotas

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/quotas \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/quotas';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/quotas"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": [
    {
      "quotaCode": "services-per-organization",
      "name": "Services per organization",
      "description": "string",
      "scope": "organization",
      "value": 20,
      "usage": 3,
      "adjustable": true
    }
  ]
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}