# ClickHouse Service API

**Canonical:** https://apis.io/apis/clickhouse/clickhouse-service-api/  
**Provider:** ClickHouse — https://apis.io/providers/clickhouse/  
**Base URL:** https://{clickhouse-host}:8443  
**Documentation:** https://clickhouse.com/docs/en/interfaces/http

ClickHouse Service API is one of 21 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 Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Service API from ClickHouse — 15 operation(s) for service.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| 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}/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 |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-service-api-openapi.yml
- **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 (12)

- [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 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/)
- [ClickHouse API keys API](https://apis.io/apis/clickhouse/clickhouse-api-keys-api/)
- [ClickHouse Backup API](https://apis.io/apis/clickhouse/clickhouse-backup-api/)
- [ClickHouse Billing API](https://apis.io/apis/clickhouse/clickhouse-billing-api/)

## Tags

Services

---

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