ClickHouse Cloud: Clickhouse Organization Quotas Get List

List a ClickHouse Cloud organization’s resource quotas with their current usage.

Tool ID: clickhouse_organization_quotas_get_list

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_organization_quotas_get_list',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_organization_quotas_get_list --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": [
      {
        "quotaCode": "services-per-organization",
        "name": "Example",
        "description": "Example description",
        "scope": "organization",
        "value": 123,
        "adjustable": true
      }
    ]
  }
}

Use deepline describe clickhouse_organization_quotas_get_list --json for the latest machine-readable contract.

Input reference

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.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the requested organization. Format: `uuid`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`array`	No	—	—
`result.data.result[].quotaCode`	`"services-per-organization" \| "postgres-services-per-organization" \| "replicas-per-warehouse"`	Yes	—	Stable identifier of the quota. Use it to request a single quota by code. Allowed: `services-per-organization`, `postgres-services-per-organization`, `replicas-per-warehouse`.
`result.data.result[].name`	`string`	Yes	—	Human-readable name of the quota.
`result.data.result[].description`	`string`	Yes	—	Explanation of the resource the quota limits and how the limit is applied.
`result.data.result[].scope`	`"organization" \| "warehouse"`	Yes	—	Granularity at which the limit is applied. For example, `replicas-per-warehouse` is an organization-wide setting that limits each warehouse individually. Allowed: `organization`, `warehouse`.
`result.data.result[].value`	`integer`	Yes	—	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.
`result.data.result[].usage`	`integer`	No	—	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.
`result.data.result[].adjustable`	`boolean`	Yes	—	Whether the limit can be raised for the organization by contacting ClickHouse support.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation