ClickHouse

ClickHouse Service API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 26

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/organizations/{organizationId}/serviceProfiles List instance profiles available in a region · List available service profiles #
Ask an LLM
“Which custom instance profiles can I use for a new service in a region?”
“What profiles are configured for my BYOC infrastructure?”
Tell an agent
List service profiles for org {org} in region {region_id}.
Show the instance profiles on BYOC infrastructure {byoc_id} in region {region_id} for organization {org}.
GET /v1/organizations/{organizationId}/services List ClickHouse services in the organization · List of organization services #
Ask an LLM
“What ClickHouse services are running in my organization?”
“Can I narrow the list of services with a filter?”
Tell an agent
List all ClickHouse services in org {org}.
Show services in organization {org} matching filter {filter}.
POST /v1/organizations/{organizationId}/services Create a new ClickHouse service · Create new service #
Ask an LLM
“How do I spin up a new ClickHouse Cloud service?”
“Can I create a service from an existing backup?”
Tell an agent
Create a ClickHouse service named {name} on {provider} in region {region} in org {org}.
Launch a new service {name} in organization {org} restored from backup {backupId}.
GET /v1/organizations/{organizationId}/services/{serviceId} Get a ClickHouse service's details · Get service details #
Ask an LLM
“What state is my ClickHouse service in right now?”
“Which endpoints and region does a particular service use?”
Tell an agent
Show ClickHouse service {service} in org {org}.
Get the state and endpoints of service {service} in organization {org}.
PATCH /v1/organizations/{organizationId}/services/{serviceId} Rename a service or change its IP access list · Update service basic details #
Ask an LLM
“How do I rename a ClickHouse service?”
“Can I restrict which IP addresses can connect to my service?”
Tell an agent
Rename service {service} in org {org} to {name}.
Set the IP access list of service {service} in organization {org} to {ipAccessList}.
DELETE /v1/organizations/{organizationId}/services/{serviceId} Delete a stopped ClickHouse service · Delete service #
Ask an LLM
“How do I permanently delete a ClickHouse service?”
“Does a service have to be stopped before I can delete it?”
Tell an agent destructive · confirm first
Delete ClickHouse service {service} in org {org}.
Permanently remove stopped service {service} from organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig Get the info needed to set up a private endpoint · Get private endpoint configuration #
Ask an LLM
“What endpoint service name do I need to set up PrivateLink to my ClickHouse service?”
“Where do I find the private DNS host for a service's private endpoint?”
Tell an agent
Get the private endpoint configuration for service {service} in org {org}.
Show what I need to connect privately to service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint Get a service's query-over-API endpoint config · Get the service query endpoint for a given instance #
Ask an LLM
“Is the query API endpoint enabled on my ClickHouse service?”
“Which roles and allowed origins are set on a service's query endpoint?”
Tell an agent
Show the service query endpoint for service {service} in org {org}.
Check which API keys can run queries over HTTP against service {service} in organization {org}.
DELETE /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint Disable the query-over-API endpoint · Delete the service query endpoint for a given instance #
Ask an LLM
“How do I turn off running queries over HTTP against my service?”
“Can I remove the query API endpoint from a service?”
Tell an agent destructive · confirm first
Delete the service query endpoint on service {service} in org {org}.
Disable query-over-API access for service {service} in organization {org}.
POST /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint Enable or configure the query-over-API endpoint · Upsert the service query endpoint for a given instance #
Ask an LLM
“How do I let an app run SQL queries against my service over an HTTP API?”
“Can I restrict the query endpoint to certain API keys and browser origins?”
Tell an agent
Enable the query endpoint on service {service} in org {org} for API keys {openApiKeys}.
Configure the query endpoint of service {service} in organization {org} with roles {roles} and allowed origins {allowedOrigins}.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/state Start, stop or wake a ClickHouse service · Update service state #
Ask an LLM
“How do I stop a ClickHouse service to save money overnight?”
“Can I wake an idle service without manage permissions?”
Tell an agent
Stop ClickHouse service {service} in org {org}.
Send state command {command} to service {service} in organization {org}.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/scaling Set total memory limits and idle scaling · Update service auto scaling settings #
Ask an LLM
“How do I set the minimum and maximum total memory for a production service?”
“Can I make my service idle after a number of minutes of inactivity?”
Tell an agent
Scale service {service} in org {org} between {minTotalMemoryGb} and {maxTotalMemoryGb} GB total memory.
Let service {service} in organization {org} go idle after {idleTimeoutMinutes} minutes using total-memory scaling settings.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/replicaScaling Set per-replica memory and replica autoscaling · Update service auto scaling settings #
Ask an LLM
“How do I set per-replica memory limits for vertical autoscaling?”
“Can I autoscale horizontally between a minimum and maximum number of replicas?”
Tell an agent
Set per-replica memory on service {service} in org {org} between {minReplicaMemoryGb} and {maxReplicaMemoryGb} GB.
Autoscale service {service} in organization {org} in mode {autoscalingMode} from {minReplicas} to {maxReplicas} replicas.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/password Change a ClickHouse service's password · Update service password #
Ask an LLM
“How do I reset the default user password on my ClickHouse service?”
“Can I set the service password by sending a hash instead of plain text?”
Tell an agent
Set a new password on service {service} in org {org} using hash {newPasswordHash}.
Reset the ClickHouse service password for {service} in organization {org} with double SHA1 hash {newDoubleSha1Hash}.
POST /v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint Add a private endpoint to a service · Create a private endpoint #
Ask an LLM
“How do I register my cloud private endpoint with a ClickHouse service?”
“Can I add a description to a private endpoint when I create it?”
Tell an agent
Create private endpoint {endpointId} for service {service} in org {org}.
Associate private endpoint {endpointId} described as {description} with service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule Get a service's scheduled autoscaling · Get service autoscaling schedule #
Ask an LLM
“Does my service have a time-based scaling schedule?”
“What scaling changes are scheduled for this service?”
Tell an agent
Show the autoscaling schedule for service {service} in org {org}.
Get the scheduled scaling entries on service {service} in organization {org}.
POST /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule Set a service's scheduled autoscaling · Create or replace service autoscaling schedule #
Ask an LLM
“How do I scale a service up during business hours and down at night on a schedule?”
“Can I clear a scaling schedule by sending no entries?”
Tell an agent
Set the autoscaling schedule for service {service} in org {org} to {entries}.
Replace the scheduled scaling on service {service} in organization {org} with entries {entries}.
DELETE /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule Remove a service's scheduled autoscaling · Delete service scheduled scaling #
Ask an LLM
“How do I delete the scaling schedule on a service?”
“What happens to the current scaling when I remove an active schedule?”
Tell an agent destructive · confirm first
Delete the scaling schedule for service {service} in org {org}.
Remove scheduled autoscaling from service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow Get a service's upgrade window · Get service upgrade window #
Ask an LLM
“When is my ClickHouse service scheduled to receive upgrades?”
“Which day and hour is the upgrade window set to?”
Tell an agent
Show the upgrade window for service {service} in org {org}.
Get the configured maintenance upgrade slot of service {service} in organization {org}.
PUT /v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow Set a service's upgrade window · Set service upgrade window #
Ask an LLM
“How do I make upgrades happen on the weekend instead of during business hours?”
“Which start hours are allowed for an upgrade window, and how long does it last?”
Tell an agent
Set the upgrade window of service {service} in org {org} to weekday {weekday} starting at {startHourUtc} UTC.
Schedule upgrades for primary service {service} in organization {org} on day {weekday} at hour {startHourUtc} UTC.
DELETE /v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow Remove a service's upgrade window · Delete service upgrade window #
Ask an LLM
“How do I go back to the default upgrade scheduling for a service?”
“Can I delete a custom upgrade window?”
Tell an agent destructive · confirm first
Delete the upgrade window on service {service} in org {org}.
Restore default upgrade scheduling for service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings List ClickHouse settings explicitly set on a service · List ClickHouse settings #
Ask an LLM
“Which ClickHouse server settings have been customized on my service?”
“What settings did we override from the platform defaults?”
Tell an agent
List the configured ClickHouse settings for service {service} in org {org}.
Show every setting overridden on service {service} in organization {org}.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings Change ClickHouse settings on a service · Update ClickHouse settings #
Ask an LLM
“How do I change a ClickHouse server setting on my service?”
“Can I update several ClickHouse settings in one call?”
Tell an agent
Apply ClickHouse settings {settings} to service {service} in org {org}.
Update the server settings on service {service} in organization {org} to {settings}.
GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema Get the schema of configurable ClickHouse settings · Get ClickHouse settings schema #
Ask an LLM
“Which ClickHouse settings am I allowed to configure, and what values are valid?”
“Where can I see types and descriptions for every tunable setting?”
Tell an agent
Get the ClickHouse settings schema for service {service} in org {org}.
Show all configurable settings and their valid values for service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName} Get one ClickHouse setting's value · Get ClickHouse setting #
Ask an LLM
“What is the current value of a specific ClickHouse setting on my service?”
“Is one particular setting still at its default?”
Tell an agent
Get ClickHouse setting {settingName} on service {service} in org {org}.
Show the current value of {settingName} for service {service} in organization {org}.
DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName} Reset a ClickHouse setting to its default · Reset ClickHouse setting to default #
Ask an LLM
“How do I undo a custom ClickHouse setting and return it to the platform default?”
“Can I remove one override without touching my other settings?”
Tell an agent destructive · confirm first
Reset ClickHouse setting {settingName} on service {service} in org {org} to default.
Remove the override for {settingName} from service {service} in organization {org}.

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: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