Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Clickhouse Cloud (BYOK) — connector documentation

  • MCP endpoint: https://byok-clickhouse-cloud.connectorbay.com/mcp
  • REST API: POST https://byok-clickhouse-cloud.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-clickhouse-cloud.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Clickhouse Cloud API key ID, sent in the X-Upstream-Key header and the API key secret in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-clickhouse-cloud.connectorbay.com/health · Tool schemas: https://byok-clickhouse-cloud.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-clickhouse-cloud · agent@connectorbay.com

What Clickhouse Cloud (BYOK) is for

Clickhouse Cloud (BYOK) lets an AI assistant read your own Clickhouse Cloud data through the Clickhouse Cloud API with a key you supply (API key ID). Read-only: 10 tools (list_organizations, get_organization, list_services, get_service, list_service_backups, get_backup_configuration, list_clickpipes, list_activities, get_usage_cost, get_quotas). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.clickhouse.cloud. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Clickhouse Cloud. Clickhouse Cloud and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which ClickHouse Cloud organization is my key for?"
  • "Show the details of my ClickHouse Cloud organization"
  • "What ClickHouse Cloud services do I have and are they running?"
  • "What are the connection endpoints and scaling limits of my ClickHouse service?"
  • "When was my ClickHouse service last backed up?"
  • "What is the backup schedule and retention of my ClickHouse service?"

What it does

  • list_organizations: List the ClickHouse Cloud organization the API key belongs to, with its ID, name and creation date.
  • get_organization: Get one ClickHouse Cloud organization: name, creation date, private endpoints and BYOC settings.
  • list_services: List the ClickHouse services of an organization with provider, region, state, tier, version and replica counts.
  • get_service: Get one ClickHouse service: state, endpoints, tier, version, replica and memory scaling limits, idling and release channel.
  • list_service_backups: List backups of a ClickHouse service with status, type, size, duration and start and finish times.
  • get_backup_configuration: Get how often a ClickHouse service is backed up, how long backups are kept and the daily start time.
  • list_clickpipes: List the ClickPipes (managed ingestion pipelines) of a service with state, scaling and destination table.
  • list_activities: List the organization's audit activity log (logins, key changes, service starts and stops) with type, actor type and time, optionally within a date range.
  • get_usage_cost: Get the organization's usage cost per day and per service or ClickPipe in ClickHouse Credits, with a grand total, for a date range of at most 30 days.
  • get_quotas: List the organization's resource quotas (services, replicas, API keys) with the limit and current usage.

BYOK key

You bring your own Clickhouse Cloud API key ID (https://clickhouse.com/docs/cloud/manage/openapi). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.clickhouse.cloud over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Notices

This covers the ClickHouse Cloud control-plane API (services, backups, costs). It does not run SQL queries against your databases. The key needs the matching view permissions.

Data sources

Live from the Clickhouse Cloud API (api.clickhouse.cloud) with a BYOK key; documentation: https://clickhouse.com/docs/cloud/manage/api/api-overview. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Clickhouse Cloud. Clickhouse Cloud and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Clickhouse Cloud account.

Built for: Worldwide. Languages: English.