api.clickhouse.cloud

Scrape ClickHouse Cloud service and organization metrics into Prometheus via the Cloud API prometheus endpoints

Start, stop, and delete a ClickHouse Cloud service safely, update its name and IP allow list, and rotate its default-user credential via the Cloud API

Provision a new ClickHouse Cloud service via POST /v1/organizations/{orgId}/services and poll until it reaches the running state

Create a scoped ClickHouse Cloud API key and authenticate to the Cloud API at https://api.clickhouse.cloud/v1 with HTTP Basic auth

Set up private connectivity (AWS PrivateLink, GCP Private Service Connect, or Azure Private Link) to a ClickHouse Cloud service via the Cloud API

Operate an existing ClickHouse Cloud ClickPipe via the API: start, stop, resync, rescale, edit settings, and delete it

Create a ClickPipe via the ClickHouse Cloud API from Kafka, Kinesis, object storage, Postgres, MySQL, MongoDB, BigQuery, or Pub/Sub, then poll until it is running

Create an API query endpoint for a saved ClickHouse Cloud query via serviceQueryEndpoint, then call the generated endpoint from a client

Read and change ClickHouse server settings on a Cloud service without SQL, using the Cloud API clickhouseSettings endpoints

Read and change ClickHouse server settings on a Cloud service without SQL, using the Cloud API clickhouseSettings endpoints

List ClickHouse Cloud backups, set retention and frequency, attach a customer-owned backup bucket, and restore into a new service via the Cloud API

Create, verify, and delete a time-based autoscaling schedule for a ClickHouse Cloud service using the scalingSchedule beta API

Configure vertical and horizontal autoscaling (memory bounds, replica counts, idle scaling) for a ClickHouse Cloud service via the Cloud API

Configure and clear a ClickHouse Cloud service's scheduled upgrade (maintenance) window via GET/PUT/DELETE upgradeWindow

Retrieve ClickHouse Cloud organization usage cost, resource quotas, and the audit/activity log via the Cloud API

Manage ClickHouse Cloud organization membership via the Cloud API: list members and roles, change a member's role, invite users, and revoke invitations