ClickHouse Cloud

ClickHouse Cloud is a fully managed cloud service for the ClickHouse analytical database. Its management API lets you administer organizations, services, ClickPipes ingestion pipelines, backups, identity and access management, and ClickStack observability resources programmatically. This connector uses the ClickHouse Cloud API at https://api.clickhouse.cloud/v1 to read those resources into Nexla and to send create/update requests back to ClickHouse Cloud.

Power end-to-end data operations for your ClickHouse Cloud API with Nexla. Our bi-directional ClickHouse Cloud connector is purpose-built for ClickHouse Cloud, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to ClickHouse Cloud or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your ClickHouse Cloud workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a ClickHouse Cloud credential, you need a ClickHouse Cloud API key, which consists of a Key ID and a Key Secret. The API uses HTTP Basic authentication, with the Key ID as the username and the Key Secret as the password. API keys are scoped to a ClickHouse Cloud organization.

To create an API key, follow these steps:

1. Sign in to the ClickHouse Cloud console with an account that has permission to manage the organization.

2. Open the API Keys page from the left-hand menu.

3. Click New API Key.

4. Enter a name for the key, and select the permissions to grant. Permissions align with ClickHouse Cloud predefined roles: the Developer role provides read-only access, while the Admin role provides full read and write access. Choose a role appropriate for how the credential will be used in Nexla — read-only for source flows, or read/write if you will use the connector as a destination.

5. Optionally set an expiration time and restrict the key to specific IP addresses or CIDR ranges.

6. Click to generate the key, then copy the Key ID and Key Secret. The Key Secret is shown only once at creation and cannot be retrieved later, so store both values securely.

For more detail on the management API, key roles, and available endpoints, see the ClickHouse Cloud API overview and the ClickHouse Cloud OpenAPI documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Key ID	Yes	No	ClickHouse Cloud API Key ID (used as the HTTP Basic username). Create one at console.clickhouse.cloud > API Keys.
Key Secret	Yes	Yes	ClickHouse Cloud API Key Secret (used as the HTTP Basic password). Shown only once at key creation.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your ClickHouse Cloud API Key ID in the Key ID field. This value is used as the HTTP Basic username for all API requests.

4. Enter your ClickHouse Cloud API Key Secret in the Key Secret field. This value is used as the HTTP Basic password and must be kept confidential.

   The Key Secret is shown only once when the API key is created in the ClickHouse Cloud console. If it is lost or compromised, delete the key and create a new one, then update this credential.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the ClickHouse Cloud connector tile, then select the credential that will be used to connect to ClickHouse Cloud, and click Next; or, create a new ClickHouse Cloud credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ClickHouse Cloud endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Many endpoints require an Organization ID (obtained from the List Organizations endpoint), and some also require a Service ID or other resource ID. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Organizations

List all organizations the API key can access.

[Rest API] Get Organization

Get details of a single organization.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List Services

List all ClickHouse services in the organization.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] Get Service

Get details of a single ClickHouse service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

[Rest API] List Activities

List organization audit-log activities. Supports from_date/to_date filters.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List Members

List members of the organization.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List API Keys

List API keys in the organization.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List Invitations

List pending organization invitations.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List Roles

List organization roles.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List Backups

List backups for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

[Rest API] List ClickPipes

List ClickPipes (ingestion pipelines) for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

[Rest API] Get ClickPipe

Get a single ClickPipe.

• Provide the Organization ID, the Service ID, and the ClickPipe ID (the ClickPipe UUID within the service).

[Rest API] Get Usage Cost

Get organization usage cost. Requires from_date/to_date.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List Postgres Services

List managed Postgres services in the organization.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint).

[Rest API] List ClickStack Alerts

List ClickStack observability alerts for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

[Rest API] List ClickStack Dashboards

List ClickStack dashboards for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

[Rest API] List ClickStack Sources

List ClickStack data sources for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

[Rest API] List ClickStack Webhooks

List ClickStack webhooks for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization).

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

ClickHouse Cloud data sources can also be manually configured to ingest data from any valid ClickHouse Cloud API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new ClickHouse Cloud data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the ClickHouse Cloud destination, and select the Send to Destination option from the menu. Select the ClickHouse Cloud connector from the list of available destination connectors, then select the credential that will be used to connect to ClickHouse Cloud, and click Next; or, create a new ClickHouse Cloud credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ClickHouse Cloud endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Many endpoints require an Organization ID and, where noted, a Service ID or other resource ID. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Service

Create a new ClickHouse service. Body is the service creation object.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint). Each record from your Nexset is sent as the JSON request body.

[Rest API] Update Service

Update an existing ClickHouse service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization). Each record from your Nexset is sent as the JSON request body.

[Rest API] Update Service State

Start or stop a ClickHouse service (state command in body).

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization). Each record from your Nexset is sent as the JSON request body.

[Rest API] Update Service Scaling

Update autoscaling limits for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization). Each record from your Nexset is sent as the JSON request body.

[Rest API] Upsert Service Query Endpoint

Create or update the service's query API endpoint.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization). Each record from your Nexset is sent as the JSON request body.

[Rest API] Create ClickPipe

Create a new ClickPipe ingestion pipeline for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization). Each record from your Nexset is sent as the JSON request body.

[Rest API] Update ClickPipe

Update an existing ClickPipe.

• Provide the Organization ID, the Service ID, and the ClickPipe ID (the ClickPipe UUID within the service). Each record from your Nexset is sent as the JSON request body.

[Rest API] Create Invitation

Invite a user to the organization.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint). Each record from your Nexset is sent as the JSON request body.

[Rest API] Create Role

Create a new organization role.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint). Each record from your Nexset is sent as the JSON request body.

[Rest API] Create ClickStack Alert

Create a ClickStack observability alert for a service.

• Provide the Organization ID and the Service ID (the ClickHouse service UUID within the organization). Each record from your Nexset is sent as the JSON request body.

[Rest API] Update Organization

Update organization details.

• Provide the Organization ID (the ClickHouse Cloud organization UUID, available from the List Organizations endpoint). Each record from your Nexset is sent as the JSON request body.

Manual configuration

ClickHouse Cloud destinations can also be manually configured to send data to any valid ClickHouse Cloud API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured ClickHouse Cloud endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the ClickHouse Cloud endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.