> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/human-access/connections-and-integrations/integration-guides/clickhouse.md).

# ClickHouse

Set up ClickHouse Auto Provisioning with a ClickHouse Cloud API key, using the Key ID and Key Secret.

### :sparkles: Auto Provisioning

| **Authentication method** | API key. `Key ID` and `Key Secret`. See details [here](#how-can-i-create-an-api-key). |
| ------------------------- | ------------------------------------------------------------------------------------- |
| **Required permissions**  | `Admin`                                                                               |
| **Required metadata**     | None                                                                                  |
| **MFA**                   | Not applicable. The API key authenticates, not a user account                         |

Agent Cake invites the user to your ClickHouse organization at the permission level you granted, and removes them when access is revoked. Pending invitations are withdrawn the same way. A provisioned user counts as invited until they accept, so they appear under Invitations in ClickHouse rather than Members.

<details>

<summary><strong>How can I create an API key?</strong></summary>

1. Navigate to the [ClickHouse Cloud console](https://console.clickhouse.cloud/).

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/231072b3-0df6-4964-a167-f116fa8cb8f1/action-4caac50a4b274133b5db580499da760a_d263c7cbdad84ddf8080d7548ba9d557_text_export.jpeg)

2. Click your organization name.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/231072b3-0df6-4964-a167-f116fa8cb8f1/action-4caac50a4b274133b5db580499da760a_0d65763a17d04f8a8071fade9c52cc67_text_export.jpeg)

3. Click `API keys`.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/5de04108-69e2-46b5-9f88-222554d92b47/action-9e19d73b82a145249346dbee9d4ae35d_cffb21d4974341d08705d64c3f71f5c9_text_export.jpeg)

4. Click `New API key`.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/2475c331-6512-4275-aa2e-6f12783fbe8d/action-40d8589bf05845528b57a164d4754733_a76581ff6bef4dd78c1dff156cbf0704_text_export.jpeg)

5. Enter a recognizable name, for example `Agent Cake`.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/f288c5cc-c4ac-49b6-be08-46cfe4c18223/action-5622614c906043d885dd681b6b5d78e9_5150ba9e4dfb4983b0f4b4b3a10f7c66_text_export.jpeg)

6. Select the `Admin` role. The `Developer` role is read only, so it cannot invite or remove users.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/0e315880-f545-40e8-b908-3b5bc1114502/action-8a2490b46abf4b4eb5657b2c7da7f3bc_76a3d3b4460c4884b657de62208dd140_text_export.jpeg)

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/599b2b08-0017-4d9a-95c6-cd789e11cf9e/action-90da9207d4bc4287b279ea6a718208e2_60f49dce01cc4061b93018d7b81044b4_text_export.jpeg)

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/23cc0fc3-cc61-4d2f-a8a3-2b53b1104c0d/action-d1188e4208374cdab9b1ba6a3b2a4e86_615a4dc4a9db4c25bcd8baa40ff20596_text_export.jpeg)

7. Click `Generate API key`.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/a392eaf2-5a6b-4f1f-8cf2-31ce3a0f6a92/action-0d3b2c33358e4814b7e49f9aed19d539_0005d3c9c1b54ae884e77f6aa727760e_text_export.jpeg)

8. Copy the `Key ID` and paste it into the corresponding field in Cakewalk.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/f08c5115-f3fc-473f-b0a7-734b63498039/user_cropped_screenshot_226b512bcdcb445382e340d6b924242d_text_export.jpeg)

9. Copy the `Key Secret` and paste it into the corresponding field in Cakewalk.

![](https://colony-recorder.s3.us-west-1.amazonaws.com/files/2026-08-21/f099d277-6802-4b13-9e12-3ba3e6a19c4e/user_cropped_screenshot_7557b2ee67ee4f6ba4540a55617f4518_text_export.jpeg)

Copy both values before you leave the screen. ClickHouse shows them once and cannot display them again.

</details>

#### Learn more

* [ClickHouse Cloud API](https://clickhouse.com/docs/cloud/manage/openapi)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.cakewalk.security/docs/human-access/connections-and-integrations/integration-guides/clickhouse.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.