# ClickHouse Cloud API

**Canonical:** https://apis.io/apis/clickhouse/clickhouse-cloud-api/  
**Provider:** ClickHouse — https://apis.io/providers/clickhouse/  
**Base URL:** https://api.clickhouse.cloud/v1  
**Documentation:** https://clickhouse.com/docs/cloud/manage/api/api-overview

ClickHouse Cloud API is one of 10 APIs that [ClickHouse](https://apis.io/providers/clickhouse/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Cloud, Control Plane, Provisioning, Billing, and Observability. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The ClickHouse Cloud control-plane REST API — 148 operations across 86 paths for organizations, services, users and roles, API keys, backups, ClickPipes, ClickStack observability, Managed Postgres, UDFs, Prometheus metrics and billing. Authenticated with HTTP Basic using an API key ID and secret. The OpenAPI 3.1.2 description is served live and unauthenticated from the API root itself, and is advertised as service-desc in the RFC 9727 api-catalog at https://clickhouse.com/.well-known/api-catalog.

## Operations (60 of 148)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/organizations` | Get list of available organizations |
| GET | `/v1/organizations/{organizationId}` | Get organization details |
| PATCH | `/v1/organizations/{organizationId}` | Update organization details |
| GET | `/v1/organizations/{organizationId}/prometheus` | Get organization metrics |
| GET | `/v1/organizations/{organizationId}/prometheus/discovery` | List Prometheus scrape targets |
| GET | `/v1/organizations/{organizationId}/roles` | List all available roles for an organization |
| POST | `/v1/organizations/{organizationId}/roles` | Create a new role |
| GET | `/v1/organizations/{organizationId}/roles/{roleId}` | Get role details |
| PATCH | `/v1/organizations/{organizationId}/roles/{roleId}` | Update a role |
| DELETE | `/v1/organizations/{organizationId}/roles/{roleId}` | Delete a role |
| GET | `/v1/organizations/{organizationId}/quotas` | Get organization quotas |
| GET | `/v1/organizations/{organizationId}/quotas/{quotaCode}` | Get organization quota details |
| GET | `/v1/organizations/{organizationId}/serviceProfiles` | List available service profiles |
| GET | `/v1/organizations/{organizationId}/services` | List of organization services |
| POST | `/v1/organizations/{organizationId}/services` | Create new service |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}` | Get service details |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}` | Update service basic details |
| DELETE | `/v1/organizations/{organizationId}/services/{serviceId}` | Delete service |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig` | Get private endpoint configuration |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint` | Get the service query endpoint for a given instance |
| DELETE | `/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint` | Delete the service query endpoint for a given instance |
| POST | `/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint` | Upsert the service query endpoint for a given instance |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/state` | Update service state |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/scaling` | Update service auto scaling settings |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling` | Update service auto scaling settings |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/password` | Update service password |
| POST | `/v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint` | Create a private endpoint |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/prometheus` | Get service metrics |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule` | Get service autoscaling schedule |
| POST | `/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule` | Create or replace service autoscaling schedule |
| DELETE | `/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule` | Delete service scheduled scaling |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow` | Get service upgrade window |
| PUT | `/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow` | Set service upgrade window |
| DELETE | `/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow` | Delete service upgrade window |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings` | List ClickHouse settings |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings` | Update ClickHouse settings |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema` | Get ClickHouse settings schema |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName}` | Get ClickHouse setting |
| DELETE | `/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName}` | Reset ClickHouse setting to default |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/backups` | List of service backups |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}` | Get backup details |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration` | Get service backup configuration |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration` | Update service backup configuration |
| GET | `/v1/organizations/{organizationId}/services/{serviceId}/backupBucket` | Get service backup bucket |
| POST | `/v1/organizations/{organizationId}/services/{serviceId}/backupBucket` | Create service backup bucket |
| PATCH | `/v1/organizations/{organizationId}/services/{serviceId}/backupBucket` | Update service backup bucket |
| DELETE | `/v1/organizations/{organizationId}/services/{serviceId}/backupBucket` | Delete service backup bucket |
| GET | `/v1/organizations/{organizationId}/keys` | Get list of all keys |
| POST | `/v1/organizations/{organizationId}/keys` | Create key |
| GET | `/v1/organizations/{organizationId}/keys/{keyId}` | Get key details |
| PATCH | `/v1/organizations/{organizationId}/keys/{keyId}` | Update key |
| DELETE | `/v1/organizations/{organizationId}/keys/{keyId}` | Delete key |
| GET | `/v1/organizations/{organizationId}/members` | List organization members |
| GET | `/v1/organizations/{organizationId}/members/{userId}` | Get member details |
| PATCH | `/v1/organizations/{organizationId}/members/{userId}` | Update organization member |
| DELETE | `/v1/organizations/{organizationId}/members/{userId}` | Remove an organization member |
| GET | `/v1/organizations/{organizationId}/invitations` | List all invitations |
| POST | `/v1/organizations/{organizationId}/invitations` | Create an invitation |
| GET | `/v1/organizations/{organizationId}/invitations/{invitationId}` | Get invitation details |
| DELETE | `/v1/organizations/{organizationId}/invitations/{invitationId}` | Delete organization invitation |

…and 88 more operations. They are listed in full on the page.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-cloud-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/overlays/clickhouse-cloud-api-overlay.yaml
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/mcp/clickhouse-tool-crosswalk.yml
- **Documentation** — https://clickhouse.com/docs/cloud/manage/api/api-overview
- **APIReference** — https://clickhouse.com/docs/products/cloud/api-reference/organization/get-list-of-available-organizations
- **Swagger** — https://clickhouse.com/docs/cloud/manage/api/swagger

## Other ClickHouse APIs (9)

- [ClickHouse HTTP Interface](https://apis.io/apis/clickhouse/clickhouse-http-interface/)
- [ClickHouse Native TCP Interface](https://apis.io/apis/clickhouse/clickhouse-native/)
- [ClickHouse MySQL Interface](https://apis.io/apis/clickhouse/clickhouse-mysql/)
- [ClickHouse PostgreSQL Interface](https://apis.io/apis/clickhouse/clickhouse-postgresql/)
- [ClickHouse gRPC Interface](https://apis.io/apis/clickhouse/clickhouse-grpc/)
- [ClickHouse ClickHouse HTTP Interface API](https://apis.io/apis/clickhouse/clickhouse-clickhouse-http-interface-api/)
- [ClickHouse Ping API](https://apis.io/apis/clickhouse/clickhouse-ping-api/)
- [ClickHouse Play API](https://apis.io/apis/clickhouse/clickhouse-play-api/)
- [ClickHouse Replicas Status API](https://apis.io/apis/clickhouse/clickhouse-replicas-status-api/)

## Tags

Cloud, Control Plane, Provisioning, Billing, Observability

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/clickhouse/clickhouse-cloud-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/clickhouse/.