Available ClickHouse APIs

Backup

Create service backup bucket

X

Delete service backup bucket

X

Get backup details

X

Get service backup bucket

X

Get service backup configuration

X

List of service backups

X

Update service backup bucket

X

Update service backup configuration

X

Billing

Get organization usage costs

X

ClickPipes

Create ClickPipe

X

Create reverse private endpoint

X

Delete ClickPipe

X

Delete reverse private endpoint

X

Get CDC ClickPipes scaling

X

Get ClickPipe

X

Get ClickPipe settings

X

Get reverse private endpoint

X

List ClickPipes

X

List reverse private endpoints

X

Update CDC ClickPipes scaling

X

Update ClickPipe

X

Update ClickPipe scaling

X

Update ClickPipe settings

X

Update ClickPipe state

X

Update reverse private endpoint

X

Click stack

Create alert

X

Create dashboard

X

Delete alert

X

Delete dashboard

X

Get alert

X

Get dashboard

X

List alerts

X

List dashboards

X

List sources

X

List webhooks

X

Update alert

X

Update dashboard

X

Open API

Create key

X

Delete key

X

Get key details

X

Get list of all keys

X

Update key

X

Organization

Create BYOC infrastructure

X

Get list of available organizations

X

Get organization details

X

Get private endpoint configuration for region within cloud provider for an organization

X

List of organization activities

X

Organization activity

X

Remove a BYOC infrastructure

X

Update BYOC infrastructure

X

Update organization details

X

Postgres

Create a read replica for a Postgres service

X

Create new Postgres service

X

Delete a PostgreSQL service

X

Get a Postgres slow query pattern with recent executions

X

Get Postgres CA certs

X

Get Postgres time-series metrics

X

Get PostgreSQL service configuration

X

Get PostgreSQL service details

X

List of organization Postgres services

X

List Postgres slow query patterns

X

Replace Postgres service configuration

X

Restore a Postgres service

X

Update a PostgreSQL service

X

Update Postgres service configuration

X

Update Postgres service state

X

Update Postgres superuser password

X

Prometheus

Get organization metrics

X

Get organization PostgreSQL metrics

X

Get PostgreSQL service metrics

X

Get service metrics

X

Role management

Create a new role

X

Delete a role

X

Get role details

X

List all available roles for an organization

X

Update a role

X

Service

Create a private endpoint

X

Create new service

X

Create or replace service autoscaling schedule

X

Delete service

X

Delete service scheduled scaling

X

Delete service upgrade window

X

Delete the service query endpoint for a given instance

X

Get ClickHouse setting

X

Get ClickHouse settings schema

X

Get private endpoint configuration

X

Get service autoscaling schedule

X

Get service details

X

Get service upgrade window

X

Get the service query endpoint for a given instance

X

List ClickHouse settings

X

List of organization services

X

Reset ClickHouse settings to default

X

Set service upgrade window

X

Update ClickHouse settings

X

Update service auto scaling settings (Replica scaling)

X

Update service auto scaling settings (Total scaling)

X

Update service basic details

X

Update service password

X

Update service state

X

Upsert the service query endpoint for a given instance

X

User management

Create an invitation

X

Delete organization invitation

X

Get invitation details

X

Get member details

X

List all invitations

X

List organization members

X

Remove an organization member

X

Update organization member

X