ClickHouse

ClickHouse Service API

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

GitHub OpenAPI

Operations 26

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 #

Documentation

📖
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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-service-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/mcp/clickhouse-tool-crosswalk.yml
🔗
Swagger
https://clickhouse.com/docs/cloud/manage/api/swagger

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clickhouse-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clickhouse-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI spec for ClickHouse Cloud Service API
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1107336
    email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-service-api-openapi.yml