How do AI agents use ClickHouse through Open Connector?

Your user connects ClickHouse once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes ClickHouse tools to your agent over MCP or a typed API, with credentials injected server-side on each call.

Is this a ClickHouse MCP server?

Yes. Open Connector can serve ClickHouse as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call ClickHouse actions with credentials injected server-side.

Where do ClickHouse credentials live?

In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

ClickHouse integration

ClickHouse integration for AI agents.

ClickHouse integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves ClickHouse tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHub All integrations →

What your agents can do

Real ClickHouse actions, managed and audited.

Your user connects ClickHouse once; your agent can then secure AI-agent actions — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

1
Your user grants ClickHouse access once (OAuth) — the token lands in the vault.
2
Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.
3
Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported ClickHouse tools.

142 tools are generated from the published ClickHouse catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 142 tools. All published catalog entries are included in this page's server-rendered HTML.

Organization activity: Returns a single organization activity by ID.; Organization
List of organization activities: Returns a list of all organization activities.; Organization
Create service backup bucket: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Create service backup bucket. Requires ADMIN auth key role.; Backup
Delete service backup bucket: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Delete service backup bucket. Requires ADMIN auth key role.; Backup
Get service backup bucket: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the service backup bucket.; Backup
Update service backup bucket: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update service backup bucket. Requires ADMIN auth key role. The secrets of the specified bucket provider are always required; Backup
Get service backup configuration: Returns the service backup configuration.; Backup
Update service backup configuration: Updates service backup configuration. Requires ADMIN auth key role. Setting the properties with null value, will reset the properties to theirs default values.; Backup
Get backup details: Returns a single backup info.; Backup
List of service backups: Returns a list of all backups for the service. The most recent backups comes first in the list.; Backup
Get CDC ClickPipes scaling: Get scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery). The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit. **Note:** For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet). **This endpoint becomes available once at least one database ClickPipe was provisioned.**; ClickPipes
Update CDC ClickPipes scaling: Update scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery). The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. Scaling settings may take a few minutes to fully propagate. For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit. If your organization tier changes, database ClickPipes will be [rescaled](https://clickhouse.com/docs/cloud/manage/billing/overview#compute) appropriately. **Note:** For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet). **This endpoint becomes available once at least one database ClickPipe was provisioned.**; ClickPipes
Create ClickPipe: Create a new ClickPipe.; ClickPipes
Delete ClickPipe: Delete the specified ClickPipe.; ClickPipes
Get ClickPipe: Returns the specified ClickPipe.; ClickPipes
List ClickPipes: Returns a list of ClickPipes.; ClickPipes
Create reverse private endpoint: Create a new reverse private endpoint.; ClickPipes
Delete reverse private endpoint: Delete the reverse private endpoint with the specified ID.; ClickPipes
Get reverse private endpoint: Returns the reverse private endpoint with the specified ID.; ClickPipes
List reverse private endpoints: Returns a list of reverse private endpoints for the specified service.; ClickPipes
Update reverse private endpoint: Update mutable fields for an existing reverse private endpoint. customPrivateDnsMappings is a full replacement list. Use an empty array to clear mappings.; ClickPipes
Update ClickPipe scaling: Change scaling settings for the specified ClickPipe. This endpoint supports Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob). **Note:** For database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery), use the [Update CDC ClickPipes scaling](#tag/ClickPipes/operation/clickPipeCdcScalingUpdate) endpoint instead.; ClickPipes
Discover ClickPipe source schema: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Infers the schema (field names and ClickHouse data types) of a streaming ClickPipe source without creating a pipe. Supported for Kafka, Kinesis sources.; ClickPipes
Get ClickPipe settings: Returns the advanced settings for the specified ClickPipe.; ClickPipes
Update ClickPipe settings: Update the advanced settings for the specified ClickPipe. Send key-value pairs where values can be strings, numbers, or booleans.; ClickPipes
Update ClickPipe state: Start, stop or resync ClickPipe. Stopping a ClickPipe will stop the ingestion process from any state. Starting is allowed for ClickPipes in the "Stopped" state or with a "Failed" state. Resyncing is only for Postgres and MySQL pipes and can be done from any state.; ClickPipes
Update ClickPipe: Update the specified ClickPipe. Source fields not present in the per-source update schemas are immutable after creation. For Kafka sources, values submitted for immutable fields (type, format, brokers, topics, consumerGroup, offset, schemaRegistry, exactlyOnce) are not applied, except schema registry credentials, which are rejected.; ClickPipes
ClickStack: Create Alert: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new alert; ClickStack
ClickStack: Create Dashboard: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new dashboard; ClickStack
ClickStack: Create Role: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new custom role for the team.; ClickStack
ClickStack: Create Saved Search: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new saved search.; ClickStack
ClickStack: Create Source: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new source. The request body is a source object without the `id` field. If an `id` is sent anyway it is silently ignored (stripped before validation — the request is never rejected because of it). Granularity fields (`materializedViews[].minGranularity` and `metadataMaterializedViews.granularity`) accept the same short format the API returns (e.g. `5m`, `15s`, `1h`, `1d`).; ClickStack
ClickStack: Create Webhook: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new webhook for the authenticated team.; ClickStack
ClickStack: Delete Alert: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes an alert; ClickStack
ClickStack: Delete Dashboard: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a dashboard; ClickStack
ClickStack: Delete Role: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a custom role. Predefined roles, the team default user role, and roles assigned to users cannot be deleted.; ClickStack
ClickStack: Delete Saved Search: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a saved search and any alerts attached to it.; ClickStack
ClickStack: Delete Source: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a source; ClickStack
ClickStack: Delete Webhook: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a webhook. Blocked with a 409 while any alert still references it — reassign or remove those alerts first — so deletion never leaves an alert pointing at a missing webhook (which would silently drop notifications). Mirrors the internal webhook delete guard.; ClickStack
ClickStack: Get Alert: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific alert by ID; ClickStack
ClickStack: Get Dashboard: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific dashboard by ID; ClickStack
ClickStack: Get Role: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific role by ID.; ClickStack
ClickStack: Get Saved Search: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific saved search by ID.; ClickStack
ClickStack: Get Source: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific source by ID; ClickStack
ClickStack: List Alerts: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves alerts for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When more records exist than are returned, `meta.total` exceeds `data.length`; clients with large collections must page with `limit`/`offset` to retrieve them all.; ClickStack
ClickStack: List Dashboards: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a list of all dashboards for the authenticated team; ClickStack
ClickStack: List Roles: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves all roles for the authenticated team, including predefined roles.; ClickStack
ClickStack: List Saved Searches: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves saved searches for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When more records exist than are returned, `meta.total` exceeds `data.length`; clients with large collections must page with `limit`/`offset` to retrieve them all.; ClickStack
ClickStack: List Sources: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a list of all sources for the authenticated team; ClickStack
ClickStack: List Webhooks: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves webhooks for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When more records exist than are returned, `meta.total` exceeds `data.length`; clients with large collections must page with `limit`/`offset` to retrieve them all.; ClickStack
ClickStack: Update Alert: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing alert; ClickStack
ClickStack: Update Dashboard: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing dashboard. **Concurrency:** This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.; ClickStack
ClickStack: Update Role: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates a custom role's permissions, name, and description. Predefined roles cannot be modified.; ClickStack
ClickStack: Update Saved Search: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing saved search. This is a full replace: send the full object. Every optional field (`select`, `where`, `whereLanguage`, `orderBy`, `tags`, `filters`) is always written and falls back to its default when omitted, so omitting a field resets it rather than preserving the stored value.; ClickStack
ClickStack: Update Source: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing source. The full source object must be provided; this is a replace, not a patch. The request body is a source object without the `id` field. If an `id` is sent anyway it is silently ignored (stripped before validation — never a 400); the path parameter alone identifies the source. Granularity fields (`materializedViews[].minGranularity` and `metadataMaterializedViews.granularity`) accept the same short format the API returns (e.g. `5m`, `15s`, `1h`, `1d`).; ClickStack
ClickStack: Update Webhook: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Replaces an existing webhook. Readable optional fields (`description`, `body`) are a full replace: omitting them clears them. The write-only fields `headers` and `queryParams` are never returned on read, so omitting them preserves the stored values; send an explicit empty object (`{}`) to clear them. Exception: if the destination (`url` or `service`) changes, omitted `headers`/ `queryParams` are cleared rather than preserved so stored secrets are never forwarded to a new destination.; ClickStack
ClickStack: Validate Dashboard: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Validates a dashboard body against the same schema and tile rules used by POST /api/v2/dashboards. The dashboard is **never persisted**. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a dashboard configuration is valid before applying it.; ClickStack
Create new service: Creates a new service in the organization, and returns the current service state and a password to access the service. The service is started asynchronously.; Service
Delete service: Deletes the service. The service must be in stopped state and is deleted asynchronously after this method call.; Service
Get service details: Returns a service that belongs to the organization; Service
List of organization services: Returns a list of all services in the organization.; Service
Update service password: Sets a new password for the service; Service
Get private endpoint configuration: Information required to set up a private endpoint; Service
Create a private endpoint: Create a new private endpoint. The private endpoint will be associated with this service and organization; Service
Get service metrics: Returns prometheus metrics for a service.; Prometheus
Delete the service query endpoint for a given instance: Removes the service query endpoint.; Service
Get the service query endpoint for a given instance: Get the configuration for the service query endpoint that allows executing queries via API.; Service
Upsert the service query endpoint for a given instance: Create the service query endpoint that allows executing queries via API.; Service
Update service auto scaling settings: Updates minimum and maximum memory limits per replica and idle mode scaling behavior for the service. Supports both vertical autoscaling (fixed replica count, variable memory) and horizontal autoscaling (variable replica count, fixed memory). The memory settings are available only for "production" services and must be a multiple of 4 starting from 8GB. For vertical autoscaling, please contact support to enable adjustment of numReplicas. For horizontal autoscaling (autoscalingMode "horizontal" with minReplicas/maxReplicas), contact support to enable the feature for your organization.; Service
Update service auto scaling settings: Updates minimum and maximum total memory limits and idle mode scaling behavior for the service. The memory settings are available only for "production" services and must be a multiple of 12 starting from 24GB. Please contact support to enable adjustment of numReplicas.; Service
Update service state: Starts or stop service; Service
Update service basic details: Updates basic service details like service name or IP access list.; Service
Create an invitation: Creates organization invitation.; User management
Delete organization invitation: Deletes a single organization invitation.; User management
Get invitation details: Returns details for a single organization invitation.; User management
List all invitations: Returns list of all organization invitations.; User management
Remove an organization member: Removes a user from the organization; User management
Get member details: Returns a single organization member details.; User management
List organization members: Returns a list of all members in the organization.; User management
Update organization member: Updates organization member role.; User management
Create key: Creates new API key.; OpenAPI
Delete key: Deletes API key. Only a key not used to authenticate the active request can be deleted.; OpenAPI
Get key details: Returns a single key details.; OpenAPI
Get list of all keys: Returns a list of all keys in the organization.; OpenAPI
Update key: Updates API key properties.; OpenAPI
Create BYOC Infrastructure: Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure; Organization
Remove a BYOC infrastructure: Removes a BYOC Infrastructure from the organization; Organization
Update BYOC Infrastructure: Update configuration of the BYOC infrastructure. Returns the modified infrastructure; Organization
Get organization details: Returns details of a single organization. In order to get the details, the auth key must belong to the organization.; Organization
Get list of available organizations: Returns a list with a single organization associated with the API key in the request.; Organization
Get private endpoint configuration for region within cloud provider for an organization: Deprecated. Please follow [documentation](https://clickhouse.com/docs/manage/security/aws-privatelink#add-endpoint-id-to-services-allow-list) for the updated process.; Organization
Get organization metrics: Returns prometheus metrics for all services in an organization.; Prometheus
Get organization quota details: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns a single organization quota identified by its quota code. Responds with a not found error when the quota code is unknown or the quota does not apply to the organization.; Organization
Get organization quotas: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the resource quotas enforced for the organization together with their current usage where available. Quotas that do not apply to the organization are omitted. Quota values reflect the limits currently enforced, so they can be polled to detect changes, for example after a billing status change. The response contains one entry per quota code; quotas enforced per resource may additionally appear under resource-scoped endpoints in the future.; Organization
Delete a role: Deletes an existing custom role. System roles cannot be deleted. This operation will remove the role and all its associated policies.; Role Management
Get role details: Returns details for a specific role.; Role Management
Update a role: Updates an existing custom role. System roles cannot be updated. All fields are optional - only provided fields will be updated.; Role Management
Create a new role: Creates a new custom role for an organization with specified policies and actors.; Role Management
List all available roles for an organization: Returns all available roles (system + custom) for an organization.; Role Management
Update organization details: Updates organization fields. Requires ADMIN auth key role.; Organization
Get PostgreSQL service configuration: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the configuration data for a Postgres service and its PgBouncer service.; Postgres
Update Postgres service configuration: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update the existing Postgres service and pgBouncer configuration.; Postgres
Replace Postgres service configuration: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Replace the existing Postgres service and pgBouncer configuration.; Postgres
Create a read replica for a Postgres service: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Initiate the process to create a new read replica for a Postgres service.; Postgres
Get Postgres time-series metrics: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns bucketed time-series metrics for a PostgreSQL service over the requested window (CPU, memory, disk, network, connections, cache hit ratio, throughput, transactions, and more). Use this to chart or analyze how a service behaved over time.; Postgres
Get PostgreSQL service metrics: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns Prometheus metrics for a PostgreSQL service.; Prometheus
Restore a Postgres service: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Restore a Postgres database from continuous backup, optionally at a specific point in time.; Postgres
Get organization PostgreSQL metrics: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns Prometheus metrics for all PostgreSQL services in an organization. Maximum 100 services supported.; Prometheus
Get Postgres CA certs: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Download CA certificates for a PostgreSQL service; Postgres
Create new Postgres service: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Creates a new Postgres service in the organization and returns it. The service is started asynchronously.; Postgres
Delete a PostgreSQL service: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Deletes a Postgres service that belongs to the organization; Postgres
Get PostgreSQL service details: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a Postgres service that belongs to the organization; Postgres
List of organization Postgres services: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a list of all Postgres services in the organization.; Postgres
Update a PostgreSQL service: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update a Postgres service that belongs to the organization. **WARNING:** Changing the name also updates the host name and certificates for the service.; Postgres
Update Postgres service state: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Initiate a process for a Postgres service: * restart: Initiates a service restart * promote: Promotes a read replica to primary * switchover: Switch a primary over to a standby; Postgres
Update Postgres superuser password: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Sets a new password for a Postgres service's superuser account.; Postgres
Delete service scheduled scaling: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Deletes the autoscaling schedule for a service. If a schedule entry is currently active, the base scaling config is restored to the instance before the schedule is removed. Returns 404 if no schedule exists. Requires the scheduled autoscaling feature to be enabled for the organization.; Service
Get service autoscaling schedule: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the autoscaling schedule for a service. Returns 404 if no schedule has been configured or if the schedule was cleared. Requires the scheduled autoscaling feature to be enabled for the organization.; Service
Create or replace service autoscaling schedule: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Creates or fully replaces the autoscaling schedule for a service. Pass an empty `entries` array to clear the schedule — a subsequent GET will return 404, and the response will contain an empty `baseConfig` (all fields absent). The base scaling config (applied when no entry is active) is managed separately via the `replicaScaling` endpoint. Requires the scheduled autoscaling feature to be enabled for the organization.; Service
Reset ClickHouse setting to default: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Removes a previously-configured ClickHouse setting, reverting its effective value to the platform default. Settings under `spec.extraConfig.server.*` (e.g. `keep_alive_timeout`, `shared_merge_tree_disable_merges_and_mutations_assignment`) trigger a ClickHouse server rollout restart; other settings propagate to all replicas after a short delay. Deleting a setting that was never configured is a no-op (200 OK).; Service
Get ClickHouse setting: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the current value of a ClickHouse setting for the service. Use the [schema endpoint](#tag/Service/operation/serviceClickhouseSettingsSchemaGet) to discover which settings are configurable.; Service
List ClickHouse settings: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the configured ClickHouse settings for the service. Only settings that have been explicitly set are included.; Service
Get ClickHouse settings schema: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the schema of all configurable ClickHouse settings, including types, valid values, descriptions, and warnings.; Service
Update ClickHouse settings: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Updates one or more ClickHouse settings for the service. To reset a setting to its platform default, use the [DELETE single setting](#tag/Service/operation/serviceClickhouseSettingDelete) endpoint. Use the [schema endpoint](#tag/Service/operation/serviceClickhouseSettingsSchemaGet) to discover which settings are configurable.; Service
Get a Postgres slow query pattern with recent executions: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns aggregate metrics for a single slow query pattern together with its most recent individual executions.; Postgres
List Postgres slow query patterns: **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns aggregate metrics for the slowest query patterns observed on a Postgres service during the given time window. Use this to discover which queries dominate total execution time, CPU, I/O, or WAL generation.; Postgres
Attach UDF to service: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Attaches one UDF version to a service, replacing the current version when necessary. When version is omitted, the latest ready version is attached.; UDF
Get UDF attachment: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the current attachment of a UDF to one service.; UDF
List UDF attachments: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the current service attachments for a UDF, with at most one attachment per service.; UDF
Create UDF: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Creates a new UDF. See [User-defined functions in Cloud](https://clickhouse.com/docs/products/cloud/features/sql-console-features/user-defined-functions).; UDF
Delete UDF: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Deletes every version of a UDF and detaches it from all services. Removal from services completes asynchronously.; UDF
Detach UDF from service: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Detaches a UDF from a service.; UDF
Get UDF: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the latest version of a UDF.; UDF
List UDFs: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the latest version of each UDF in the organization.; UDF
Create UDF upload URL: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Creates an org-scoped presigned application/zip upload URL. Callers must use an upload ID for only one create or version attempt and request a new upload URL when retrying.; UDF
Create UDF version: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Consumes a source archive, assigns a version, and starts the UDF build. Optional configuration fields omitted from the request use the defaults documented in the request schema; values are not inherited from the previous version. Retry by requesting a new upload URL and re-uploading.; UDF
Delete UDF version: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Deletes a UDF version. The UDF must not be attached to any services.; UDF
List UDF versions: **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns all versions of a UDF.; UDF
Delete service upgrade window: Deletes the upgrade window for a service, restoring the default scheduling behaviour. The upgrade window can only be deleted on primary services. Deletion succeeds even if the organization has lost the scheduled upgrades entitlement, so a window can be cleared after entitlement loss. Errors: - 400: the service is a secondary service. - 401: missing, invalid, or disabled API key. - 403: caller lacks `control-plane:service:manage` on the service. - 404: service does not exist, is not visible to the caller, or no upgrade window is configured.; Service
Get service upgrade window: Returns the configured upgrade window for a service. Errors: - 401: missing, invalid, or disabled API key. - 403: caller lacks `control-plane:service:view` on the service. - 404: service does not exist, is not visible to the caller, or no upgrade window has been configured.; Service
Set service upgrade window: Creates or fully replaces the upgrade window for a service. The upgrade window currently lasts 6 hours from `startHourUtc`. The upgrade window can only be set on primary services; secondary services inherit the primary service window. Errors: - 400: invalid field values (`weekday` not in 0–6, `startHourUtc` not in {0, 6, 12, 18}), or the service is a secondary service. - 401: missing, invalid, or disabled API key. - 403: caller lacks `control-plane:service:manage` on the service, or the organization does not have the scheduled upgrades feature enabled. - 404: service does not exist or is not visible to the caller.; Service
Get organization usage costs: Returns a grand total and a list of daily, per-entity organization usage cost records for the organization in the queried time period (maximum 31 days). All days in both the request and the response are evaluated based on the UTC timezone.; Billing

FAQ

ClickHouse integration, answered

How do AI agents use ClickHouse through Open Connector?: Your user connects ClickHouse once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes ClickHouse tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a ClickHouse MCP server?: Yes. Open Connector can serve ClickHouse as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call ClickHouse actions with credentials injected server-side.
Where do ClickHouse credentials live?: In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents ClickHouse — keep the keys.

Open source, self-hostable, with ClickHouse credentials that never leave your infrastructure. Run it from source today.

View source on GitHub How the MCP gateway works →