list_backups
List Backups
List all backups for a ClickHouse service, with the most recent backups listed first. Includes backup status, timestamps, and size.
list_backups
List all backups for a ClickHouse service, with the most recent backups listed first. Includes backup status, timestamps, and size.
update_member
Update an organization member's role or assigned roles. Use this to promote, demote, or change permissions for a member.
control_service_state
Start, stop, or wake an idle ClickHouse service. A service must be stopped before it can be deleted.
delete_query_endpoint
Delete the query endpoint configuration for a service.
get_backup_configuration
Retrieve the current backup configuration for a service, including backup schedule and retention settings.
get_clickpipe_settings
Retrieve tunable settings for a ClickPipe.
update_clickstack_dashboard
Update a ClickStack dashboard. The official API expects a full dashboard body including name and tiles.
update_clickpipe
Update a ClickPipe's name, source, destination, field mappings, or settings. This uses the official ClickPipes PATCH endpoint.
list_clickstack_sources
List ClickStack data sources for a service. Source IDs are needed when creating or updating dashboard tiles.
update_api_key
Update a ClickHouse Cloud API key's name, state, role assignments, expiration, or IP allow list.
configure_clickpipe_scaling
Configure scaling for a Kafka, object storage, or streaming ClickPipe.
delete_service
Delete a ClickHouse service. The service **must be stopped** before deletion. Deletion is asynchronous and cannot be undone.
list_invitations
List all pending invitations for the organization. Shows who has been invited, their assigned roles, deprecated role, and expiration dates.
create_invitation
Invite a new member to the organization by email. Specify the role and optional assigned role IDs.
upsert_query_endpoint
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.
delete_invitation
Revoke a pending invitation. The invitee will no longer be able to join the organization using this invitation.
get_usage
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_api_key
Permanently delete an API key. The key used to authenticate the current request cannot be deleted.
update_clickstack_alert
Update a ClickStack alert. Pass the alert fields supported by the official ClickStack alert update request.
get_clickpipe
Retrieve detailed information about a specific ClickPipe, including its source configuration, destination, state, and scaling settings.
create_api_key
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_clickstack_dashboard
Create a new ClickStack observability dashboard for a service. Dashboards can contain tiles with charts configured with SQL or Lucene queries and aggregation functions.
get_clickstack_dashboard
Retrieve a ClickStack dashboard, including tiles, tags, filters, and saved query defaults.
get_organization
Retrieve the details of the ClickHouse Cloud organization, including its name, creation date, private endpoints, and BYOC configuration.
list_clickstack_alerts
List all ClickStack alerts configured for a service. Alerts support webhook notifications to services like Slack and PagerDuty.
list_reverse_private_endpoints
List all reverse private endpoints for a service. Reverse private endpoints allow ClickHouse Cloud to securely initiate connections to private customer resources.
get_service
Retrieve detailed information about a specific ClickHouse service, including its state, scaling configuration, endpoints, IP access list, tags, and encryption settings.
delete_byoc_infrastructure
Delete a BYOC infrastructure from the organization.
create_service
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.
list_api_keys
List all API keys in the organization. Shows key names, states, expiration dates, and assigned roles.
list_activities
Retrieve the audit log of organization activities. Optionally filter by date range to see who performed what actions and when.
get_private_endpoint_config
Retrieve the private endpoint configuration for a specific service. Shows available private endpoint service IDs for connecting from your cloud VPC.
insert_rows
Insert JSON object rows into a ClickHouse table over the HTTP interface using FORMAT JSONEachRow.
configure_scaling
Update the scaling configuration for a ClickHouse service. Adjust replica memory ranges, number of replicas, idle scaling behavior, and idle timeout.
get_api_key
Retrieve details for a ClickHouse Cloud API key. The key secret is not returned by the Cloud API after creation.
create_reverse_private_endpoint
Create a new reverse private endpoint for a service, enabling ClickHouse Cloud to securely connect to your private resources.
delete_clickstack_alert
Delete a ClickStack alert from a service.
configure_cdc_clickpipes_scaling
Configure shared CPU and memory scaling for database CDC ClickPipes on a service.
run_query_endpoint
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.
get_cdc_clickpipes_scaling
Retrieve shared scaling configuration for database CDC ClickPipes on a service.
list_tables
List tables visible to the supplied ClickHouse database user, optionally scoped to one database.
get_clickstack_alert
Retrieve a ClickStack alert, including state, schedule, threshold, and notification channel details.
list_clickpipes
List all ClickPipes (data ingestion pipelines) for a service. Shows pipeline names, states, scaling settings, and source configurations.
update_service
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.
remove_member
Remove a member from the organization. This action is irreversible.
describe_table
Describe a ClickHouse table and return column metadata.
create_byoc_infrastructure
Create new Bring Your Own Cloud (BYOC) infrastructure in the organization. BYOC lets you deploy ClickHouse services in your own cloud account.
delete_clickstack_dashboard
Delete a ClickStack dashboard from a service.
delete_reverse_private_endpoint
Delete a reverse private endpoint from a service.
update_backup_configuration
Update the backup configuration for a service. Modify backup schedules, retention periods, and other backup settings.
update_byoc_infrastructure
Update an existing BYOC infrastructure configuration, such as its display name.
get_prometheus_metrics
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.
create_clickpipe
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.
list_clickstack_dashboards
List all ClickStack observability dashboards for a service. ClickStack is the built-in observability platform for ClickHouse Cloud.
control_clickpipe_state
Change the state of a ClickPipe. Start, stop, or resync a data ingestion pipeline.
list_services
List all ClickHouse services in the organization. Optionally filter services by tags. Returns service names, states, cloud provider, region, scaling configuration, and endpoints.
execute_query
Execute a read-only SQL query against a ClickHouse service over the HTTP interface. Mutating statements are rejected; use insert_rows for inserts.
list_databases
List databases available to the supplied ClickHouse database user via the HTTP interface.
delete_clickpipe
Delete a ClickPipe data ingestion pipeline from a service.
list_members
List all members in the organization. Returns each member's user ID, name, email, assigned roles, deprecated role, and join date.
get_backup
Retrieve details for a specific ClickHouse service backup.
update_clickpipe_settings
Replace tunable settings for a ClickPipe. The request body is passed to the official ClickPipe settings PUT endpoint.
list_clickstack_webhooks
List ClickStack webhook destinations for a service. Webhook IDs are needed for alert notification channels.
create_clickstack_alert
Create a new ClickStack alert for a service. Alerts monitor metrics and send notifications via webhooks (Slack, PagerDuty, etc.) when thresholds are breached.
get_query_endpoint
Retrieve the query endpoint configuration for a service. Query endpoints expose saved SQL queries as HTTP API endpoints.
get_role
Retrieve a ClickHouse Cloud organization role by ID.
list_roles
List organization roles available for assignment to members and API keys.
Manage ClickHouse Cloud organizations, services, and infrastructure via the REST API. Create, start, stop, and delete analytical database services. Configure scaling policies, replicas, and resource allocation. Manage backups, API keys, and organization members. Create and manage ClickPipes data ingestion pipelines from sources like Kafka, S3, Kinesis, PostgreSQL, and MySQL. Set up query API endpoints from saved SQL queries. Manage private endpoints, retrieve usage and cost metrics, fetch Prometheus metrics, and configure BYOC (Bring Your Own Cloud) infrastructure. Create and manage observability dashboards, alerts, and webhook notifications via ClickStack.
Common questions about connecting Clickhouse to AI agents with Metorial.