Set up docs MCPOverview
The ClickHouse Cloud API is a REST API designed for developers to easily manage organizations and services on ClickHouse Cloud. Using our Cloud API, you can create and manage services, provision API keys, and add or remove members in your organization, and more.
Learn how to create your first API key and start using the ClickHouse Cloud API.
Swagger (OpenAPI) Endpoint and UI
The ClickHouse Cloud API is built on the open-source OpenAPI specification to allow for predictable client-side consumption. If you need to programmatically consume the ClickHouse Cloud API docs, we offer a JSON-based Swagger endpoint via https://api.clickhouse.cloud/v1. You can also find the API docs via the Swagger UI.
Rate limits
Developers are limited to 100 API keys per organization. Each API key has a limit of 10 requests over a 10-second window. If you’d like to increase the number of API keys or requests per 10-second window for your organization, please contact support@clickhouse.com
Terraform provider
The official ClickHouse Terraform Provider lets you use Infrastructure as Code to create predictable, version-controlled configurations to make deployments much less error-prone.
You can view the Terraform provider docs in the Terraform registry.
If you’d like to contribute to the ClickHouse Terraform Provider, you can view the source in the GitHub repo.
Terraform provider releases
ClickHouse maintains two official Terraform providers - the ClickHouse Cloud provider for cloud infrastructure and the DBops provider for database-level objects. Both follow the same release model.
GA versus Beta resources
Every release is a single build that contains all resources. Resources for features that have not yet reached general availability ship alongside GA ones, marked as beta — there is no separate build and nothing to pin to use them.
A beta resource announces itself in two places:
- At plan and apply time, as a
Beta Resourcewarning. Terraform never fails on warnings, so the run proceeds normally. - In its documentation, with a callout reading “This resource is in beta”.
Beta means the schema and behavior may change in a future provider version. Anything without the marker is GA and covered by the usual compatibility guarantees.
Versioning
Both providers use semantic versioning (MAJOR.MINOR.PATCH). The major version is incremented for breaking changes, the minor version for new features or resources, and the patch version for bug fixes. Releases are cut on demand rather than on a fixed schedule.
Versions with an -alphaN suffix (e.g., 3.15.0-alpha3) predate the single-build model. They remain available but are no longer produced.
Promotion from beta to GA
When a feature reaches general availability, its resource drops the beta marker in the next provider release: the plan-time warning stops appearing, and the docs callout is removed. Nothing else changes — no configuration edits, no state migration, and no switching between builds.
Terraform and OpenAPI New Pricing: Replica Settings Explained
The number of replicas each service will be created with defaults to 3 for the Scale and Enterprise tiers, while it defaults to 1 for the Basic tier.
For the Scale and the Enterprise tiers it is possible to adjust it by passing a numReplicas field in the service creation request.
The value of the numReplicas field must be at least 2 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. For the maximum number of replicas, see Usage limits.
Support
We recommend visiting our Slack channel first to get quick support. If you’d like additional help or more info about our API and its capabilities, please contact ClickHouse Support at https://console.clickhouse.cloud/support