ClickHouse Cloud Plugin

Manage ClickHouse Cloud services, organizations, backups, and more through the ClickHouse Cloud API.

Features

• Organizations - List and manage organizations
• Services - Create, update, delete, start/stop ClickHouse services
• Backups - View and manage backup configurations
• API Keys - Create and manage API keys
• Members - Manage organization members and invitations
• ClickPipes - Manage data ingestion pipelines
• Prometheus Metrics - Access monitoring data

Quick Start

1. Get API Credentials

1. Go to ClickHouse Cloud Console
2. Navigate to Settings > API Keys
3. Create a new API key
4. Copy both the Key ID and Key Secret

2. Configure Environment

Create a .env file with your credentials:

CLICKHOUSE_API_KEY=your_key_id_here
CLICKHOUSE_API_SECRET=your_key_secret_here

3. Test Connection

opencode run "test clickhouse connection" --print-logs

Available Tools (60 total)

Organization Management

• clickhouse-organization-get-list - List all organizations
• clickhouse-organization-get - Get organization details
• clickhouse-organization-update - Update organization

Service Management

• clickhouse-instance-get-list - List all services
• clickhouse-instance-get - Get service details
• clickhouse-instance-create - Create a new service
• clickhouse-instance-update - Update service configuration
• clickhouse-instance-delete - Delete a service
• clickhouse-instance-state-update - Start/stop a service
• clickhouse-instance-replica-scaling-update - Scale replicas
• clickhouse-instance-password-update - Update default password

Backup Management

• clickhouse-backup-get-list - List backups
• clickhouse-backup-get - Get backup details
• clickhouse-backup-configuration-get - Get backup configuration
• clickhouse-backup-configuration-update - Update backup configuration

API Key Management

• clickhouse-openapi-key-get-list - List API keys
• clickhouse-openapi-key-create - Create new API key
• clickhouse-openapi-key-get - Get API key details
• clickhouse-openapi-key-delete - Delete API key

Member Management

• clickhouse-member-get-list - List organization members
• clickhouse-member-get - Get member details
• clickhouse-invitation-get-list - List invitations
• clickhouse-invitation-create - Invite new member

ClickPipes (Data Ingestion)

• clickhouse-click-pipe-get-list - List ClickPipes
• clickhouse-click-pipe-create - Create ClickPipe
• clickhouse-click-pipe-state-update - Start/stop ClickPipe

Monitoring

• clickhouse-instance-prometheus-get - Get Prometheus metrics
• clickhouse-organization-prometheus-get - Get org-level metrics

Example Queries

# List organizations
opencode run "list my clickhouse organizations"

# List all services
opencode run "list all clickhouse services in organization abc123"

# Get service details
opencode run "get details for clickhouse service xyz789"

# Start a service
opencode run "start clickhouse service xyz789 in organization abc123"

# Stop a service
opencode run "stop clickhouse service xyz789"

# View service backups
opencode run "list backups for clickhouse service xyz789"

# Get prometheus metrics
opencode run "get prometheus metrics for clickhouse service xyz789"

Authentication

ClickHouse Cloud API uses HTTP Basic Authentication:

• Username: API Key ID (CLICKHOUSE_API_KEY)
• Password: API Key Secret (CLICKHOUSE_API_SECRET)

Read-Only Mode

To restrict to read-only operations:

pets read-only clickhouse on

This disables all write operations (create, update, delete, start, stop).

Regenerating Tools

If the ClickHouse Cloud API is updated, regenerate tools:

cd pets/clickhouse
pets generate-openapi --verbose

Resources

• ClickHouse Cloud API Docs
• OpenAPI Spec
• ClickHouse Cloud Console