At a glance
- Availability: Experimental (how to enable).
- Auth: Basic auth.
- Connection: HTTP Basic auth with
CLICKHOUSE_KEY_IDas the username andCLICKHOUSE_KEY_SECRETas the password. - Docs: https://clickhouse.com/docs/cloud/manage/openapi
Credentials
Set these per environment. See Connect an integration.Setup
- Sign in to ClickHouse Cloud: Go to https://console.clickhouse.cloud and sign in (a free trial organization with one service is enough for testing).
- Create an API key: In the console, open the API Keys tab in the left menu, click New API Key, choose permissions (developer for read-only is sufficient for these tools), and set an expiration.
- Copy the key ID and secret: Copy the Key ID and Key Secret immediately - they are not shown again. Add them to your .env as CLICKHOUSE_KEY_ID and CLICKHOUSE_KEY_SECRET.
- Verify access: Run List Organizations, then List Services with the organization ID it returns.
- Authentication is HTTP Basic: the key ID is the username and the key secret is the password
- This connector targets the ClickHouse Cloud management API (api.clickhouse.cloud), not the SQL interface of your ClickHouse database
- API responses wrap payloads in a top-level ‘result’ field
Tools
| Tool | Access | Description |
|---|---|---|
| List Organizations | Read | List organizations the API key has access to |
| Get Organization | Read | Get details of an organization |
| List Services | Read | List all ClickHouse services in an organization |
| Get Service | Read | Get details of a ClickHouse service, including endpoints and state |
Example prompts
- List my ClickHouse Cloud services with their state, provider, and region.
- Get the details of my ClickHouse Cloud service and tell me whether it is running and where its endpoints are.