ClickHouse

ClickHouse Organization API

The Organization API from ClickHouse — 9 operation(s) for organization.

GitHub OpenAPI

Operations 16

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 Find the organization tied to my API key · Get list of available organizations #
Ask an LLM
“Which ClickHouse Cloud organization does my API key belong to?”
“How do I find my organization ID to use in other calls?”
Tell an agent
List the organizations available to my API key.
Look up the organization ID associated with this key.
GET /v1/organizations/{organizationId} Get organization details · Get organization details #
Ask an LLM
“What are the name and settings of my organization?”
“Are core dumps enabled for our organization?”
Tell an agent
Show details for organization {org}.
Get the name and private endpoints configured on org {org}.
PATCH /v1/organizations/{organizationId} Rename or reconfigure the organization · Update organization details #
Ask an LLM
“How do I rename our organization?”
“Can I turn core dumps on or off for the whole organization?”
Tell an agent
Rename organization {org} to {name}.
Set core dumps enabled to {enableCoreDumps} for org {org}.
GET /v1/organizations/{organizationId}/quotas List organization resource quotas and usage · Get organization quotas #
Ask an LLM
“What resource limits apply to my organization and how close am I to them?”
“Did our quotas change after our billing status changed?”
Tell an agent
List all quotas and current usage for organization {org}.
Show every limit enforced on org {org}.
GET /v1/organizations/{organizationId}/quotas/{quotaCode} Get one organization quota by code · Get organization quota details #
Ask an LLM
“What is the limit and current usage for one specific quota?”
“How many more of a given resource can we create before hitting the quota?”
Tell an agent
Get quota {quotaCode} for organization {org}.
Check usage against the {quotaCode} quota in org {org}.
GET /v1/organizations/{organizationId}/activities List the organization's activity log · List of organization activities #
Ask an LLM
“Who changed what in our organization over the last week?”
“Can I pull an audit trail of org activities between two dates?”
Tell an agent
List all activities in organization {org}.
Show activity in org {org} from {from_date} to {to_date}.
GET /v1/organizations/{organizationId}/activities/{activityId} Get one organization activity entry · Organization activity #
Ask an LLM
“What exactly happened in a particular audit log entry?”
“Who performed a specific activity and when?”
Tell an agent
Show activity {activityId} in organization {org}.
Get the actor and timestamp for audit entry {activityId} in org {org}.
GET /v1/organizations/{organizationId}/privateEndpointConfig Get org private endpoint config for a region (deprecated) · Get private endpoint configuration for region within cloud provider for an… #
Ask an LLM
“What private endpoint configuration applies to a cloud region at the organization level?”
“Where is the older org-wide PrivateLink setup info for a given cloud provider?”
Tell an agent
Get the deprecated org-level private endpoint config for org {org} on {cloud_provider} in region {region_id}.
Show organization {org}'s private endpoint settings for cloud {cloud_provider}, region {region_id}.
POST /v1/organizations/{organizationId}/byocInfrastructure Create BYOC infrastructure in my cloud account · Create BYOC Infrastructure #
Ask an LLM
“How do I set up Bring Your Own Cloud infrastructure in my own account?”
“Can I choose the VPC CIDR range and availability zones for a BYOC deployment?”
Tell an agent
Create BYOC infrastructure for org {org} in account {accountId}, region {regionId}.
Provision BYOC infrastructure named {displayName} in organization {org} using VPC CIDR {vpcCidrRange}.
POST /v1/organizations/{organizationId}/byocInfrastructure/validate Validate BYOC infrastructure prerequisites #
GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} Get BYOC infrastructure details #
DELETE /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} Remove BYOC infrastructure · Remove a BYOC infrastructure #
Ask an LLM
“How do I remove a Bring Your Own Cloud infrastructure from our organization?”
“Can I decommission BYOC infrastructure we no longer use?”
Tell an agent destructive · confirm first
Remove BYOC infrastructure {byoc} from organization {org}.
Delete the BYOC deployment {byoc} in org {org}.
PATCH /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} Rename BYOC infrastructure · Update BYOC Infrastructure #
Ask an LLM
“Can I change the display name of existing BYOC infrastructure?”
“What can I modify on a BYOC infrastructure after it's created?”
Tell an agent
Rename BYOC infrastructure {byoc} in org {org} to {displayName}.
Update the display name of BYOC deployment {byoc} in organization {org} to {displayName}.
GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress Get BYOC infrastructure provisioning progress #
GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/tags Get BYOC infrastructure tags #
GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/privateEndpointConfig Get BYOC infrastructure private endpoint configuration #

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-organization-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-organization-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-organization-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI spec for ClickHouse Cloud Organization 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 (79 KB total) ---
# Full source: https://artifacts.apis.io/clickhouse/openapi/clickhouse-organization-api-openapi.yml