Built by Metorial, the integration platform for agentic AI.
Create a new ClickPipe data ingestion pipeline for a service. ClickPipes support sources like Apache Kafka, object storage, Amazon Kinesis, PostgreSQL, MySQL, BigQuery, and MongoDB. Provide the source configuration and destination table settings.
Retrieve tunable settings for a ClickPipe.
Delete a ClickStack alert from a service.
Describe a ClickHouse table and return column metadata.
List organization roles available for assignment to members and API keys.
Update a ClickStack alert. Pass the alert fields supported by the official ClickStack alert update request.
Permanently delete an API key. The key used to authenticate the current request cannot be deleted.
List all backups for a ClickHouse service, with the most recent backups listed first. Includes backup status, timestamps, and size.
Configure scaling for a Kafka, object storage, or streaming ClickPipe.
Retrieve the audit log of organization activities. Optionally filter by date range to see who performed what actions and when.
Delete a ClickPipe data ingestion pipeline from a service.
Invite a new member to the organization by email. Specify the role and optional assigned role IDs.
Retrieve the details of the ClickHouse Cloud organization, including its name, creation date, private endpoints, and BYOC configuration.
Remove a member from the organization. This action is irreversible.
Update a ClickHouse service's configuration, including its name, IP access list, tags, release channel, and endpoint settings. Use separate tools for scaling and state changes.
Retrieve detailed information about a specific ClickHouse service, including its state, scaling configuration, endpoints, IP access list, tags, and encryption settings.
Delete a ClickStack dashboard from a service.
Delete the query endpoint configuration for a service.
List all ClickStack alerts configured for a service. Alerts support webhook notifications to services like Slack and PagerDuty.
List all ClickPipes (data ingestion pipelines) for a service. Shows pipeline names, states, scaling settings, and source configurations.
Retrieve a ClickStack alert, including state, schedule, threshold, and notification channel details.
Retrieve Prometheus-format metrics for all services or a specific service. Includes metrics from system.metrics, system.events, and system.asynchronous_metrics. Idle services only return the ClickHouse_ServiceInfo gauge.
Retrieve details for a ClickHouse Cloud API key. The key secret is not returned by the Cloud API after creation.
Update the scaling configuration for a ClickHouse service. Adjust replica memory ranges, number of replicas, idle scaling behavior, and idle timeout.
Retrieve a ClickHouse Cloud organization role by ID.
List all ClickStack observability dashboards for a service. ClickStack is the built-in observability platform for ClickHouse Cloud.
Retrieve detailed information about a specific ClickPipe, including its source configuration, destination, state, and scaling settings.
Delete a ClickHouse service. The service **must be stopped** before deletion. Deletion is asynchronous and cannot be undone.
Create a new ClickStack observability dashboard for a service. Dashboards can contain tiles with charts configured with SQL or Lucene queries and aggregation functions.
List tables visible to the supplied ClickHouse database user, optionally scoped to one database.
Change the state of a ClickPipe. Start, stop, or resync a data ingestion pipeline.
Execute a saved ClickHouse Cloud Query API endpoint using OpenAPI key Basic Auth. Supports endpoint versions, ClickHouse response formats, query variables, request timeout, and ClickHouse settings.
Delete a reverse private endpoint from a service.
Update a ClickHouse Cloud API key's name, state, role assignments, expiration, or IP allow list.
List databases available to the supplied ClickHouse database user via the HTTP interface.
Replace tunable settings for a ClickPipe. The request body is passed to the official ClickPipe settings PUT endpoint.
Update an existing BYOC infrastructure configuration, such as its display name.
List ClickStack webhook destinations for a service. Webhook IDs are needed for alert notification channels.
Create a new ClickHouse Cloud service. Specify the cloud provider, region, scaling settings, and other configuration. The response includes the generated database password — store it securely as it cannot be retrieved later.
Update the backup configuration for a service. Modify backup schedules, retention periods, and other backup settings.
Create new Bring Your Own Cloud (BYOC) infrastructure in the organization. BYOC lets you deploy ClickHouse services in your own cloud account.
Create a new reverse private endpoint for a service, enabling ClickHouse Cloud to securely connect to your private resources.
Create a new ClickStack alert for a service. Alerts monitor metrics and send notifications via webhooks (Slack, PagerDuty, etc.) when thresholds are breached.
Retrieve shared scaling configuration for database CDC ClickPipes on a service.
Create a new API key for the organization. Specify the key name, permissions/roles, expiration, and optional IP restrictions. The key secret is only returned once — store it securely.
Create or update a query endpoint for a service. Query endpoints allow creating API endpoints directly from saved SQL queries. Supports parameterized queries, custom API key access, and CORS policies.
List all reverse private endpoints for a service. Reverse private endpoints allow ClickHouse Cloud to securely initiate connections to private customer resources.
Start, stop, or wake an idle ClickHouse service. A service must be stopped before it can be deleted.
List all pending invitations for the organization. Shows who has been invited, their assigned roles, deprecated role, and expiration dates.
List all ClickHouse services in the organization. Optionally filter services by tags. Returns service names, states, cloud provider, region, scaling configuration, and endpoints.
Update a ClickPipe's name, source, destination, field mappings, or settings. This uses the official ClickPipes PATCH endpoint.
Insert JSON object rows into a ClickHouse table over the HTTP interface using FORMAT JSONEachRow.
Retrieve the private endpoint configuration for a specific service. Shows available private endpoint service IDs for connecting from your cloud VPC.
List all members in the organization. Returns each member's user ID, name, email, assigned roles, deprecated role, and join date.
List all API keys in the organization. Shows key names, states, expiration dates, and assigned roles.
Retrieve the query endpoint configuration for a service. Query endpoints expose saved SQL queries as HTTP API endpoints.
List ClickStack data sources for a service. Source IDs are needed when creating or updating dashboard tiles.
Execute a read-only SQL query against a ClickHouse service over the HTTP interface. Mutating statements are rejected; use insert_rows for inserts.
Update a ClickStack dashboard. The official API expects a full dashboard body including name and tiles.
Retrieve the current backup configuration for a service, including backup schedule and retention settings.
Revoke a pending invitation. The invitee will no longer be able to join the organization using this invitation.
Retrieve usage and cost information for the organization over a date range. Covers Storage, Compute, Data Transfer, ClickPipes, and Backup costs. Maximum queryable range is 31 days.
Delete a BYOC infrastructure from the organization.
Retrieve details for a specific ClickHouse service backup.
Configure shared CPU and memory scaling for database CDC ClickPipes on a service.
Update an organization member's role or assigned roles. Use this to promote, demote, or change permissions for a member.
Retrieve a ClickStack dashboard, including tiles, tags, filters, and saved query defaults.