rocketkind
Databases

ClickHouse Cloud

ClickHouse Cloud is the managed ClickHouse service.

Authentication

  • API key

Actions

Generic API request. Call any ClickHouse Cloud control-plane endpoint on this connection, for the case where no shipped action covers it yet (ClickPipes, roles, invitations, backup configuration, Postgres services, …). The connection supplies the base URL (by default https://api.clickhouse.cloud/v1), the HTTP Basic authentication and…

  • Create serviceCreate a new ClickHouse service in an organization.
  • Get organizationRead one organization's details — name, creation time, its private endpoints and any Bring-Your-Own-Cloud infrastructure — under body.result.
  • Get serviceRead one ClickHouse service: its current state, ClickHouse version, scaling settings, IP access list and the host/port of each endpoint (https, nativesecure, mysql) under body.result.
  • Get usage costReport an organization's usage cost in ClickHouse Credits (CHC) for up to 31 days: body.result.grandTotalCHC is the period total and body.result.costs holds one record per entity (data warehouse, service, ClickPipe) per UTC day with storage, compute, backup and transfer breakdowns.
  • List activitiesRead the organization's audit log — service creates, starts, stops and deletions, API key changes, member and role changes — each with who did it (actorType, actorDetails), from which IP and when, under body.result.
  • List API keysAudit the organization's API keys: name, state (enabled or disabled), roles, expiry and when each was last used, under body.result.
  • List backupsList a service's backups, newest first, with each backup's status (done, error, inprogress), type (full or incremental), start and finish times and size under body.result.
  • List membersList everyone in an organization with their email, join date and assigned roles (system and custom) under body.result.
  • List organizationsList the ClickHouse Cloud organizations this API key can reach — always exactly one, because a key belongs to one organization.
  • List query API endpointsList a service's Query API endpoints — saved SQL queries exposed over HTTPS — with each one's name, database, run URL and which API keys may call it, under body.result.items.
  • List servicesList every ClickHouse service in an organization with its state (running, stopped, idle, …), cloud provider and region, scaling settings and connection endpoints.
  • Run query endpointDestructiveRun a saved ClickHouse Query API endpoint and get its rows back — the way to read data out of a ClickHouse Cloud service from a workflow without a database driver.
  • Start or stop serviceDestructiveStart, stop or wake a ClickHouse service — for example stop a dev service at night and start it in the morning.
  • Update service scalingDestructiveChange how a ClickHouse service autoscales: per-replica memory bounds, replica count (fixed or a min/max band), and whether it idles to zero.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.