> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud

> Manage ClickHouse Cloud organizations and services

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: Basic auth.
* **Connection**: HTTP Basic auth with `CLICKHOUSE_KEY_ID` as the username and `CLICKHOUSE_KEY_SECRET` as the password.
* **Docs**: [https://clickhouse.com/docs/cloud/manage/openapi](https://clickhouse.com/docs/cloud/manage/openapi)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable                | Required | Description                                                                                                                 |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| `CLICKHOUSE_KEY_ID`     | Yes      | ClickHouse Cloud API key ID (used as the HTTP Basic username) [Docs](https://clickhouse.com/docs/cloud/manage/openapi).     |
| `CLICKHOUSE_KEY_SECRET` | Yes      | ClickHouse Cloud API key secret (used as the HTTP Basic password) [Docs](https://clickhouse.com/docs/cloud/manage/openapi). |

## Setup

1. **Sign in to ClickHouse Cloud**: Go to [https://console.clickhouse.cloud](https://console.clickhouse.cloud) and sign in (a free trial organization with one service is enough for testing).
2. **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.
3. **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.
4. **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

Provider API reference: [https://clickhouse.com/docs/cloud/manage/api/api-overview](https://clickhouse.com/docs/cloud/manage/api/api-overview)

## 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.