ClickHouse

ClickHouse Backup API

The Backup API from ClickHouse — 4 operation(s) for backup.

GitHub OpenAPI
Business capability
Disaster Recovery & Resilience BC-4220.60

Operations 8

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}/services/{serviceId}/backups List a service's backups · List of service backups #
Ask an LLM
“What backups exist for my ClickHouse service, newest first?”
“When was the most recent backup of this service taken?”
Tell an agent
List all backups for service {service} in org {org}.
Show the latest backups taken of service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId} Get details of one backup · Get backup details #
Ask an LLM
“What are the details of one particular backup?”
“Did a specific backup of my service finish successfully?”
Tell an agent
Show backup {backupId} of service {service} in org {org}.
Check whether backup {backupId} for service {service} in organization {org} completed.
GET /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration Get a service's backup schedule and retention · Get service backup configuration #
Ask an LLM
“How often is my service backed up and how long are backups kept?”
“What start time is configured for this service's backups?”
Tell an agent
Show the backup configuration for service {service} in org {org}.
Tell me the backup period and retention settings on service {service} in organization {org}.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration Change a service's backup schedule and retention · Update service backup configuration #
Ask an LLM
“Can I take backups every 12 hours and keep them longer?”
“How do I reset the backup schedule back to its defaults?”
Tell an agent
Back up service {service} in org {org} every {backupPeriodInHours} hours.
Keep backups of service {service} in organization {org} for {backupRetentionPeriodInHours} hours, starting at {backupStartTime}.
GET /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Get a service's custom backup bucket · Get service backup bucket #
Ask an LLM
“Which external bucket are my service's backups written to?”
“Is a bring-your-own backup bucket configured for this service?”
Tell an agent
Show the backup bucket configured for service {service} in org {org}.
Check whether service {service} in organization {org} sends backups to its own bucket.
POST /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Set up a custom backup bucket for a service · Create service backup bucket #
Ask an LLM
“How do I send my service's backups to a bucket in my own cloud account?”
“What role does my API key need to add a backup bucket?”
Tell an agent
Create a backup bucket for service {service} in org {org}.
Configure service {service} in organization {org} to write backups to my own bucket.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Update a service's custom backup bucket · Update service backup bucket #
Ask an LLM
“How do I rotate the credentials on my existing backup bucket?”
“Do I have to resend the bucket secrets every time I change the backup bucket?”
Tell an agent
Update the existing backup bucket settings for service {service} in org {org}.
Rotate the secrets on the backup bucket already attached to service {service} in organization {org}.
DELETE /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Remove a service's custom backup bucket · Delete service backup bucket #
Ask an LLM
“How do I stop using my own bucket for a service's backups?”
“Can I detach the external backup bucket from a service?”
Tell an agent destructive · confirm first
Delete the backup bucket configured on service {service} in org {org}.
Remove the custom backup bucket 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://artifacts.apis.io/clickhouse/openapi/clickhouse-backup-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://artifacts.apis.io/clickhouse/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-backup-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-backup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI spec for ClickHouse Cloud Backup API
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1256081
    email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://artifacts.apis.io/clickhouse/openapi/clickhouse-backup-api-openapi.yml