How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ClickHouse

ClickHouse Cloud API

The ClickHouse Cloud control-plane REST API — 148 operations across 86 paths for organizations, services, users and roles, API keys, backups, ClickPipes, ClickStack observability, Managed Postgres, UDFs, Prometheus metrics and billing. Authenticated with HTTP Basic using an API key ID and secret. The OpenAPI 3.1.2 description is served live and unauthenticated from the API root itself, and is advertised as service-desc in the RFC 9727 api-catalog at https://clickhouse.com/.well-known/api-catalog.

Documentation Provider Profile APIs.io OpenAPI GitHub

ClickHouse Cloud API is one of 10 APIs that ClickHouse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cloud, Control Plane, Provisioning, Billing, and Observability. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 148 operations across 86 paths, organized into 12 resource areas, and defines 369 schemas. It is described by OpenAPI 3.1.2, at version 1.0.

Requests are made against a single base URL, https://api.clickhouse.cloud.

148 operations 86 paths 369 schemas 23 DELETE68 GET22 PATCH26 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
1.0
Base URL
https://api.clickhouse.cloud/v1
Authentication
HTTP Basic
Contact
ClickHouse Support
Resource Areas
12

Authentication & Security 1

ClickHouse Cloud API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Paths & Operations 148

Across 86 paths, the API surfaces 148 operations — 23 DELETE, 68 GET, 22 PATCH, 26 POST, 9 PUT. They span 12 resource areas, including Organization, Prometheus, Role Management, Service, Backup, API keys, User management, Billing, and 4 more. Each is listed below with its method, path, parameters, and response codes.

Organization 11
GET
/v1/organizations
Get list of available organizations
organizationGetList → 200400500
GET
/v1/organizations/{organizationId}
Get organization details
organizationGet 1 param → 200400500
PATCH
/v1/organizations/{organizationId}
Update organization details
organizationUpdate 1 param body → 200400500
GET
/v1/organizations/{organizationId}/quotas
Get organization quotas
organizationQuotasGetList 1 param → 200400500
GET
/v1/organizations/{organizationId}/quotas/{quotaCode}
Get organization quota details
organizationQuotaGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/activities
List of organization activities
activityGetList 3 params → 200400500
GET
/v1/organizations/{organizationId}/activities/{activityId}
Organization activity
activityGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/privateEndpointConfigdeprecated
Get private endpoint configuration for region within cloud provider for an organization
organizationPrivateEndpointConfigGetList 3 params → 200400500
POST
/v1/organizations/{organizationId}/byocInfrastructure
Create BYOC Infrastructure
organizationByocInfrastructureCreate 1 param body → 200400500
DELETE
/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}
Remove a BYOC infrastructure
organizationByocInfrastructureDelete 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}
Update BYOC Infrastructure
organizationByocInfrastructureUpdate 2 params body → 200400500
Prometheus 5
GET
/v1/organizations/{organizationId}/prometheusdeprecated
Get organization metrics
organizationPrometheusGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/prometheus/discovery
List Prometheus scrape targets
organizationPrometheusDiscoveryGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/prometheus
Get service metrics
instancePrometheusGet 3 params → 200400500
GET
/v1/organizations/{organizationId}/postgres/prometheus
Get organization PostgreSQL metrics
postgresOrgPrometheusGet 1 param → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/prometheus
Get PostgreSQL service metrics
postgresInstancePrometheusGet 2 params → 200400500
Role Management 5
GET
/v1/organizations/{organizationId}/roles
List all available roles for an organization
organizationRolesGetList 1 param → 200400500
POST
/v1/organizations/{organizationId}/roles
Create a new role
organizationRolePost 1 param body → 200400500
GET
/v1/organizations/{organizationId}/roles/{roleId}
Get role details
organizationRoleGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/roles/{roleId}
Update a role
organizationRolePatch 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/roles/{roleId}
Delete a role
organizationRoleDelete 2 params → 200400500
Service 26
GET
/v1/organizations/{organizationId}/serviceProfiles
List available service profiles
serviceProfilesList 3 params → 200400500
GET
/v1/organizations/{organizationId}/services
List of organization services
instanceGetList 2 params → 200400500
POST
/v1/organizations/{organizationId}/services
Create new service
instanceCreate 1 param body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}
Get service details
instanceGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}
Update service basic details
instanceUpdate 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}
Delete service
instanceDelete 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig
Get private endpoint configuration
instancePrivateEndpointConfigGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint
Get the service query endpoint for a given instance
instanceQueryEndpointGet 2 params → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint
Delete the service query endpoint for a given instance
instanceQueryEndpointDelete 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint
Upsert the service query endpoint for a given instance
instanceQueryEndpointUpsert 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/state
Update service state
instanceStateUpdate 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/scalingdeprecated
Update service auto scaling settings
instanceScalingUpdate 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling
Update service auto scaling settings
instanceReplicaScalingUpdate 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/password
Update service password
instancePasswordUpdate 2 params body → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint
Create a private endpoint
instancePrivateEndpointCreate 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule
Get service autoscaling schedule
scalingScheduleGet 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule
Create or replace service autoscaling schedule
scalingScheduleUpsert 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule
Delete service scheduled scaling
scalingScheduleDelete 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow
Get service upgrade window
upgradeWindowGet 2 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow
Set service upgrade window
upgradeWindowUpdate 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow
Delete service upgrade window
upgradeWindowDelete 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings
List ClickHouse settings
serviceClickhouseSettingsListGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings
Update ClickHouse settings
serviceClickhouseSettingsUpdate 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema
Get ClickHouse settings schema
serviceClickhouseSettingsSchemaGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName}
Get ClickHouse setting
serviceClickhouseSettingGet 3 params → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName}
Reset ClickHouse setting to default
serviceClickhouseSettingDelete 3 params → 200400500
Backup 8
GET
/v1/organizations/{organizationId}/services/{serviceId}/backups
List of service backups
backupGetList 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}
Get backup details
backupGet 3 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration
Get service backup configuration
backupConfigurationGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration
Update service backup configuration
backupConfigurationUpdate 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/backupBucket
Get service backup bucket
backupBucketGet 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/backupBucket
Create service backup bucket
backupBucketCreate 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/backupBucket
Update service backup bucket
backupBucketUpdate 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/backupBucket
Delete service backup bucket
backupBucketDelete 2 params → 200400500
API keys 5
GET
/v1/organizations/{organizationId}/keys
Get list of all keys
openapiKeyGetList 1 param → 200400500
POST
/v1/organizations/{organizationId}/keys
Create key
openapiKeyCreate 1 param body → 200400500
GET
/v1/organizations/{organizationId}/keys/{keyId}
Get key details
openapiKeyGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/keys/{keyId}
Update key
openapiKeyUpdate 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/keys/{keyId}
Delete key
openapiKeyDelete 2 params → 200400500
User management 8
GET
/v1/organizations/{organizationId}/members
List organization members
memberGetList 1 param → 200400500
GET
/v1/organizations/{organizationId}/members/{userId}
Get member details
memberGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/members/{userId}
Update organization member
memberUpdate 2 params body → 200400500
DELETE
/v1/organizations/{organizationId}/members/{userId}
Remove an organization member
memberDelete 2 params → 200400500
GET
/v1/organizations/{organizationId}/invitations
List all invitations
invitationGetList 1 param → 200400500
POST
/v1/organizations/{organizationId}/invitations
Create an invitation
invitationCreate 1 param body → 200400500
GET
/v1/organizations/{organizationId}/invitations/{invitationId}
Get invitation details
invitationGet 2 params → 200400500
DELETE
/v1/organizations/{organizationId}/invitations/{invitationId}
Delete organization invitation
invitationDelete 2 params → 200400500
Billing 3
GET
/v1/organizations/{organizationId}/usageCost
Get organization usage costs
usageCostGet 4 params → 200400500
GET
/v1/organizations/{organizationId}/activeBalancesdeprecated
Get organization active prepaid balances
activeBalancesGet 3 params → 200400500
GET
/v1/organizations/{organizationId}/creditBalances
Get organization active credit balances
creditBalancesGet 1 param → 200400500
ClickPipes 18
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes
List ClickPipes
clickPipeGetList 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes
Create ClickPipe
clickPipeCreate 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/context
Get ClickPipes service context
clickPipesServiceContextGet 2 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
Get ClickPipe
clickPipeGet 3 params → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
Update ClickPipe
clickPipeUpdate 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}
Delete ClickPipe
clickPipeDelete 3 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings
Get ClickPipe settings
clickPipeSettingsGet 3 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings
Update ClickPipe settings
clickPipeSettingsUpdate 3 params body → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/schemaDiscovery
Discover ClickPipe source schema
clickPipeSchemaDiscovery 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling
Update ClickPipe scaling
clickPipeScalingUpdate 3 params body → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state
Update ClickPipe state
clickPipeStateUpdate 3 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling
Get CDC ClickPipes scaling
clickPipeCdcScalingGet 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling
Update CDC ClickPipes scaling
clickPipeCdcScalingUpdate 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
List reverse private endpoints
clickPipeReversePrivateEndpointGetList 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
Create reverse private endpoint
clickPipeReversePrivateEndpointCreate 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}
Get reverse private endpoint
clickPipeReversePrivateEndpointGet 3 params → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}
Delete reverse private endpoint
clickPipeReversePrivateEndpointDelete 3 params → 200400500
PATCH
/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}
Update reverse private endpoint
clickPipeReversePrivateEndpointUpdate 3 params body → 200400500
ClickStack 30
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards
ClickStack: List Dashboards
clickStackListDashboards 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards
ClickStack: Create Dashboard
clickStackCreateDashboard 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}
ClickStack: Get Dashboard
clickStackGetDashboard 3 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}
ClickStack: Update Dashboard
clickStackUpdateDashboard 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}
ClickStack: Delete Dashboard
clickStackDeleteDashboard 3 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/validate
ClickStack: Validate Dashboard
clickStackValidateDashboard 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts
ClickStack: List Alerts
clickStackListAlerts 4 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts
ClickStack: Create Alert
clickStackCreateAlert 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources
ClickStack: List Sources
clickStackListSources 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources
ClickStack: Create Source
clickStackCreateSource 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}
ClickStack: Get Source
clickStackGetSource 3 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}
ClickStack: Update Source
clickStackUpdateSource 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}
ClickStack: Delete Source
clickStackDeleteSource 3 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
ClickStack: Get Alert
clickStackGetAlert 3 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
ClickStack: Update Alert
clickStackUpdateAlert 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
ClickStack: Delete Alert
clickStackDeleteAlert 3 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks
ClickStack: List Webhooks
clickStackListWebhooks 4 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks
ClickStack: Create Webhook
clickStackCreateWebhook 2 params body → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}
ClickStack: Update Webhook
clickStackUpdateWebhook 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}
ClickStack: Delete Webhook
clickStackDeleteWebhook 3 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles
ClickStack: List Roles
clickStackListRoles 2 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles
ClickStack: Create Role
clickStackCreateRole 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}
ClickStack: Get Role
clickStackGetRole 3 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}
ClickStack: Update Role
clickStackUpdateRole 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}
ClickStack: Delete Role
clickStackDeleteRole 3 params → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches
ClickStack: List Saved Searches
clickStackListSavedSearches 4 params → 200400500
POST
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches
ClickStack: Create Saved Search
clickStackCreateSavedSearch 2 params body → 200400500
GET
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}
ClickStack: Get Saved Search
clickStackGetSavedSearch 3 params → 200400500
PUT
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}
ClickStack: Update Saved Search
clickStackUpdateSavedSearch 3 params body → 200400500
DELETE
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}
ClickStack: Delete Saved Search
clickStackDeleteSavedSearch 3 params → 200400500
Postgres 17
POST
/v1/organizations/{organizationId}/postgres
Create new Postgres service
postgresServiceCreate 1 param body → 200400500
GET
/v1/organizations/{organizationId}/postgres
List of organization Postgres services
postgresServiceGetList 1 param → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}
Get PostgreSQL service details
postgresServiceGet 2 params → 200400500
DELETE
/v1/organizations/{organizationId}/postgres/{postgresId}
Delete a PostgreSQL service
postgresServiceDelete 2 params → 200400500
PATCH
/v1/organizations/{organizationId}/postgres/{postgresId}
Update a PostgreSQL service
postgresServicePatch 2 params body → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/caCertificates
Get Postgres CA certs
postgresServiceCertsGet 2 params → 200400500
POST
/v1/organizations/{organizationId}/postgres/{postgresId}/restoredService
Restore a Postgres service
postgresInstanceRestore 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/postgres/{postgresId}/password
Update Postgres superuser password
postgresServiceSetPassword 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/postgres/{postgresId}/state
Update Postgres service state
postgresServicePatchState 2 params body → 200400500
POST
/v1/organizations/{organizationId}/postgres/{postgresId}/readReplica
Create a read replica for a Postgres service
postgresInstanceCreateReadReplica 2 params body → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/config
Get PostgreSQL service configuration
postgresInstanceConfigGet 2 params → 200400500
POST
/v1/organizations/{organizationId}/postgres/{postgresId}/config
Replace Postgres service configuration
postgresInstanceConfigPost 2 params body → 200400500
PATCH
/v1/organizations/{organizationId}/postgres/{postgresId}/config
Update Postgres service configuration
postgresInstanceConfigPatch 2 params body → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/metrics
Get Postgres time-series metrics
postgresInstanceMetricsGet 5 params → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns
List Postgres slow query patterns
slowQueryPatternsGetList 12 params → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns/{queryId}
Get a Postgres slow query pattern with recent executions
slowQueryPatternGet 8 params → 200400500
GET
/v1/organizations/{organizationId}/postgres/{postgresId}/logs
List Postgres server logs
postgresLogsGetList 9 params → 200400500
UDF 12
PUT
/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}
Attach UDF to service
udfAttach 3 params body → 200400404409422424500
GET
/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}
Get UDF attachment
udfAttachmentGet 3 params → 200400404500
DELETE
/v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}
Detach UDF from service
udfDetach 3 params → 200400404409500
GET
/v1/organizations/{organizationId}/udfs/{functionName}/attachments
List UDF attachments
udfAttachmentList 4 params → 200400404500
POST
/v1/organizations/{organizationId}/udfs
Create UDF
udfCreate 1 param body → 201400403409410500
GET
/v1/organizations/{organizationId}/udfs
List UDFs
udfList 3 params → 200400500
DELETE
/v1/organizations/{organizationId}/udfs/{functionName}
Delete UDF
udfDelete 2 params → 200400404409500
GET
/v1/organizations/{organizationId}/udfs/{functionName}
Get UDF
udfGet 2 params → 200400404500
POST
/v1/organizations/{organizationId}/udfUploads/url
Create UDF upload URL
udfUploadSessionCreate 1 param → 201400500
POST
/v1/organizations/{organizationId}/udfs/{functionName}/versions
Create UDF version
udfVersionCreate 2 params body → 201400403404409410500
GET
/v1/organizations/{organizationId}/udfs/{functionName}/versions
List UDF versions
udfVersionList 4 params → 200400404500
DELETE
/v1/organizations/{organizationId}/udfs/{functionName}/versions/{version}
Delete UDF version
udfVersionDelete 3 params → 200400404409500

Schemas 369

The contract defines 369 schemas that model the data the API accepts and returns. The most detailed are PostgresQueryExecution (43 properties), ServiceScalingPatchResponse (40 properties), Service (40 properties), ClickStackTraceSource (35 properties). Each schema is shown below with its type and property counts.

ResourceTagsV1
object
2 properties 1 required
ScalingScheduleEntry
object
13 properties 7 required
ScalingScheduleBaseConfig
object
7 properties
ScalingSchedule
object
3 properties 2 required
ScalingScheduleEntryRequest
object
12 properties 4 required
ScalingSchedulePostRequest
object
1 property 1 required
CurrentScaling
object
8 properties
ServiceEndpoint
object
4 properties
IpAccessListEntry
object
2 properties
Service
object
40 properties 2 required
PrivateEndpointConfig
object
2 properties
ServiceQueryAPIEndpoint
object
4 properties
ServiceEndpointChange
object
2 properties
IpAccessListPatch
object
2 properties
InstanceTagsPatch
object
2 properties
InstancePrivateEndpointsPatch
object
2 properties
InstancePrivateEndpoint
object
4 properties
OrganizationPrivateEndpoint
object
4 properties
ByocConfig
object
6 properties
Organization
object
6 properties
OrganizationCloudRegionPrivateEndpointConfig
object
1 property
PrometheusDiscoveryLabels
object
6 properties
PrometheusDiscoveryTargetGroup
object
2 properties
OrganizationPatchPrivateEndpoint
object
4 properties
OrganizationPrivateEndpointsPatch
object
2 properties
RBACPolicyTags
object
2 properties
RBACPolicy
object
7 properties
RBACRole
object
9 properties
RBACPolicyCreateRequest
object
4 properties 3 required
RoleCreateRequest
object
3 properties 3 required
RoleUpdateRequest
object
3 properties
UsageCostMetrics
object
10 properties
UsageCostRecord
object
9 properties
UsageCost
object
2 properties
CustomPrivateDnsMapping
object
1 property
CreateReversePrivateEndpoint
object
9 properties
UpdateReversePrivateEndpoint
object
1 property
ReversePrivateEndpoint
object
15 properties
PLAIN
object
2 properties
MskIamUser
object
2 properties
ServiceAccount
object
1 property 1 required
ClickPipeKafkaOffset
object
2 properties
ClickPipeKafkaSchemaRegistry
object
3 properties
ClickPipeKafkaSchemaRegistryCredentials
object
2 properties
ClickPipeMutateKafkaSchemaRegistry
object
4 properties
AzureEventHub
object
1 property
MutualTLS
object
2 properties
ClickPipeKafkaSource
object
12 properties
ClickPipePostKafkaSource
object
14 properties
ClickPipePatchKafkaSource
object
5 properties
ClickPipeKinesisSource
object
8 properties
ClickPipePostKinesisSource
object
9 properties
ClickPipePatchKinesisSource
object
3 properties
ClickPipeObjectStorageSource
object
14 properties
ClickPipePostObjectStorageSource
object
16 properties
ClickPipePatchObjectStorageSource
object
9 properties
ClickPipePostgresPipeSettings
object
11 properties
ClickPipePatchPostgresPipeSettings
object
2 properties
ClickPipePostgresPipeTableMapping
object
9 properties
ClickPipePatchPostgresPipeRemoveTableMapping
object
6 properties
ClickPipePostgresSource
object
12 properties
ClickPipeMutatePostgresSource
object
13 properties
ClickPipePatchPostgresSource
object
11 properties
ClickPipeMySQLPipeSettings
object
10 properties 1 required
ClickPipePatchMySQLPipeSettings
object
3 properties
ClickPipeMySQLPipeTableMapping
object
9 properties 3 required
ClickPipePatchMySQLPipeRemoveTableMapping
object
6 properties 3 required
ClickPipeMySQLSource
object
12 properties 4 required
ClickPipeMutateMySQLSource
object
13 properties 4 required
ClickPipePatchMySQLSource
object
13 properties 2 required
ClickPipeBigQueryPipeSettings
object
5 properties 1 required
ClickPipeBigQueryPipeTableMapping
object
7 properties 3 required
ClickPipeBigQueryServiceAccountSource
object
5 properties 4 required
ClickPipeBigQueryWorkloadIdentitySource
object
5 properties 4 required
ClickPipeBigQuerySource
ClickPipePostBigQueryServiceAccountSource
object
6 properties 4 required
ClickPipePostBigQueryWorkloadIdentitySource
object
5 properties 5 required
ClickPipeMutateBigQuerySource
ClickPipeMongoDBPipeSettings
object
7 properties 1 required
ClickPipePatchMongoDBPipeSettings
object
2 properties
ClickPipeMongoDBPipeTableMapping
object
4 properties 3 required
ClickPipePatchMongoDBPipeRemoveTableMapping
object
4 properties 3 required
ClickPipeMongoDBSource
object
8 properties 2 required
ClickPipeMutateMongoDBSource
object
9 properties 4 required
ClickPipePatchMongoDBSource
object
10 properties 2 required
ClickPipePubSubSource
object
9 properties 5 required
ClickPipePostPubSubServiceAccountSource
object
10 properties 6 required
ClickPipePostPubSubWorkloadIdentitySource
object
9 properties 5 required
ClickPipePostPubSubSource
ClickPipePatchPubSubSource
object
3 properties 1 required
ClickPipesGcpWorkloadIdentityContext
object
3 properties
ClickPipesServiceContext
object
1 property
ClickPipeScaling
object
4 properties
ClickPipeSource
object
8 properties
ClickPipeDestinationColumn
object
2 properties
ClickPipeDestinationTableEngine
object
3 properties
ClickPipeDestinationTableDefinition
object
4 properties
ClickPipeDestination
object
5 properties
ClickPipeFieldMapping
object
2 properties
ClickPipeSettings
object
13 properties
ClickPipe
object
11 properties
ClickPipePostSource
object
9 properties
ClickPipePatchSource
object
8 properties
ClickPipeMutateDestination
object
6 properties
ClickPipePatchDestination
object
1 property
ClickPipesCdcScaling
object
2 properties
ClickPipeSettingsPutRequest
object
13 properties
ClickPipeSchemaDiscoverySource
object
4 properties
ClickPipeSchemaDiscoveryField
object
3 properties
ClickPipeSchemaDiscoveryMeta
object
Source-specific schema discovery metadata.
ClickPipeSchemaDiscoveryResponse
object
2 properties
Activity
object
16 properties
AwsBackupBucket
object
5 properties
GcpBackupBucket
object
4 properties
AzureBackupBucket
object
3 properties
BackupBucket
AwsBackupBucketProperties
object
4 properties
GcpBackupBucketProperties
object
3 properties
AzureBackupBucketProperties
object
2 properties
BackupBucketProperties
AwsBackupBucketPostRequestV1
object
4 properties
GcpBackupBucketPostRequestV1
object
4 properties
AzureBackupBucketPostRequestV1
object
3 properties
BackupBucketPostRequest
AwsBackupBucketPatchRequestV1
object
4 properties
GcpBackupBucketPatchRequestV1
object
4 properties
AzureBackupBucketPatchRequestV1
object
3 properties
BackupBucketPatchRequest
BackupConfiguration
object
3 properties
Backup
object
10 properties
ClickStackAlertExecutionError
object
3 properties 3 required
ClickStackAlertSilenced
object
3 properties
ClickStackAlertChannelEmail
object
2 properties 2 required
ClickStackAlertChannelWebhook
object
5 properties 2 required
ClickStackAlertChannel
ClickStackAlertChannels
array
Notification channels to trigger when the alert fires or resolves. Between 1 and 10 channels; duplicates are rejected.
ClickStackAlertResponse
object
24 properties
ClickStackCreateAlertRequest
object
17 properties
ClickStackUpdateAlertRequest
object
17 properties
ClickStackSqlSavedFilterValue
object
2 properties 1 required
ClickStackVariableSavedFilterValue
object
3 properties 3 required
ClickStackSavedFilterValue
ClickStackNumberFormat
object
9 properties
ClickStackBackgroundChart
object
2 properties 1 required
ClickStackNumericColorCondition
object
4 properties 3 required
ClickStackBetweenColorCondition
object
4 properties 3 required
ClickStackEqualityColorCondition
object
4 properties 3 required
ClickStackNumberTileColorCondition
ClickStackTimeChartSeries
object
13 properties 6 required
ClickStackTableChartSeries
object
13 properties 6 required
ClickStackNumberChartSeries
object
11 properties 5 required
ClickStackSearchChartSeries
object
5 properties 5 required
ClickStackMarkdownChartSeries
object
2 properties 2 required
ClickStackDashboardChartSeries
ClickStackSelectItem
object
10 properties 1 required
ClickStackFormula
object
3 properties 1 required
ClickStackLineBuilderChartConfig
object
13 properties 3 required
ClickStackBarBuilderChartConfig
object
11 properties 3 required
ClickStackOnClickTargetIdVariant
object
2 properties 2 required
ClickStackOnClickTargetTemplateVariant
object
2 properties 2 required
ClickStackOnClickTarget
ClickStackOnClickFilterTemplate
object
3 properties 3 required
ClickStackOnClickSearch
object
5 properties 2 required
ClickStackOnClickDashboard
object
5 properties 2 required
ClickStackOnClickExternal
object
2 properties 2 required
ClickStackOnClick
ClickStackTableBuilderChartConfig
object
12 properties 3 required
ClickStackNumberBuilderChartConfig
object
8 properties 3 required
ClickStackPieBuilderChartConfig
object
7 properties 3 required
ClickStackCategoricalBarBuilderChartConfig
object
7 properties 3 required
ClickStackHeatmapSelectItem
object
3 properties 1 required
ClickStackHeatmapChartConfig
object
6 properties 3 required
ClickStackSearchChartConfig
object
5 properties 4 required
ClickStackEventPatternsChartConfig
object
5 properties 2 required
ClickStackMarkdownChartConfig
object
2 properties 1 required
ClickStackLineRawSqlChartConfig
object
10 properties 4 required
ClickStackBarRawSqlChartConfig
object
8 properties 4 required
ClickStackTableRawSqlChartConfig
object
7 properties 4 required
ClickStackNumberRawSqlChartConfig
object
7 properties 4 required
ClickStackPieRawSqlChartConfig
object
6 properties 4 required
ClickStackCategoricalBarRawSqlChartConfig
object
6 properties 4 required
ClickStackLineChartConfig
ClickStackBarChartConfig
ClickStackTableChartConfig
ClickStackNumberChartConfig
ClickStackPieChartConfig
ClickStackCategoricalBarChartConfig
ClickStackTileConfig
ClickStackDashboardContainerTab
object
2 properties 2 required
ClickStackDashboardContainer
object
6 properties 3 required
ClickStackTileOutput
object
9 properties 6 required
ClickStackTileInput
object
11 properties 5 required
ClickStackFilterInput
object
11 properties 4 required
ClickStackFilter
object
12 properties 5 required
ClickStackCreateDashboardRequest
object
8 properties 2 required
ClickStackValidateDashboardError
object
2 properties 2 required
ClickStackValidateDashboardResponseNormalized
ClickStackValidateDashboardResponse
object
3 properties 3 required
ClickStackUpdateDashboardRequest
object
8 properties 2 required
ClickStackDashboardResponse
object
9 properties
ClickStackCASLPermissionConditions
object
ClickStackCASLPermission
object
5 properties 2 required
ClickStackRole
object
7 properties 4 required
ClickStackCreateRoleRequest
object
3 properties 2 required
ClickStackUpdateRoleRequest
object
3 properties 1 required
ClickStackValidationErrorItemErrors
object
ClickStackValidationErrorItem
object
2 properties
ClickStackValidationError
array
zod-express-middleware validation failures.
ClickStackSavedSearchFilter
object
2 properties 1 required
ClickStackSavedSearch
object
12 properties 3 required
ClickStackSavedSearchInput
object
8 properties 2 required
ClickStackQuerySetting
object
2 properties 2 required
ClickStackFilterSettingsColumn
object
4 properties 2 required
ClickStackSourceFilterSettings
object
3 properties 3 required
ClickStackSourceFrom
object
2 properties 2 required
ClickStackMetricSourceFrom
object
2 properties 1 required
ClickStackMetricTables
object
5 properties
ClickStackHighlightedAttributeExpression
object
3 properties 1 required
ClickStackAggregatedColumn
object
3 properties 2 required
ClickStackMaterializedView
object
7 properties 6 required
ClickStackLogSourceMetadataMaterializedViews
object
3 properties
ClickStackLogSource
object
29 properties 6 required
ClickStackTraceSourceMetadataMaterializedViews
object
3 properties
ClickStackTraceSource
object
35 properties 13 required
ClickStackMetricSource
object
12 properties 7 required
ClickStackSessionSource
object
10 properties 5 required
ClickStackPromqlSource
object
9 properties 5 required
ClickStackSource
ClickStackSlackWebhook
object
7 properties 5 required
ClickStackIncidentIOWebhook
object
7 properties 5 required
ClickStackGenericWebhook
object
8 properties 5 required
ClickStackSlackAPIWebhook
object
7 properties 5 required
ClickStackPagerDutyAPIWebhook
object
7 properties 5 required
ClickStackWebhook
ClickStackWebhookInputHeaders
object
ClickStackWebhookInputQueryParams
object
ClickStackWebhookInput
object
7 properties 3 required
AssignedRole
object
3 properties
Member
object
6 properties
Invitation
object
6 properties
License
object
5 properties
ScimEnterpriseManager
object
2 properties
ScimEnterpriseUser
object
6 properties
ScimUserName
object
6 properties
ScimUserEmail
object
3 properties 1 required
ScimUserMeta
object
4 properties 3 required
ScimUserGroup
object
3 properties
ScimUserRole
object
4 properties
ScimUserEntitlement
object
4 properties
ScimUserPhoneNumber
object
3 properties
ScimUserIm
object
3 properties
ScimUserPhoto
object
3 properties
ScimUserAddress
object
8 properties
ScimX509Certificate
object
1 property
ScimUser
object
25 properties 7 required
ScimUserPostRequest
object
24 properties 3 required
ScimListResponse
object
5 properties 5 required
ScimPatchOperation
object
3 properties 1 required
ScimPatchOp
object
2 properties 2 required
ScimUserPutRequest
object
26 properties 3 required
ScimGroupMember
object
3 properties 1 required
ScimGroupMeta
object
4 properties 3 required
ScimGroup
object
6 properties 4 required
ScimGroupPostRequest
object
4 properties 2 required
ScimGroupPutRequest
object
6 properties 2 required
ScimGroupListResponse
object
5 properties 5 required
ScimBooleanFeature
object
1 property 1 required
ScimServiceProviderConfigPatch
object
1 property 1 required
ScimServiceProviderConfigBulk
object
3 properties 3 required
ScimServiceProviderConfigFilter
object
2 properties 2 required
ScimAuthenticationScheme
object
5 properties 3 required
ScimServiceProviderConfigMeta
object
2 properties 2 required
ScimServiceProviderConfig
object
10 properties 9 required
ScimSchemaExtension
object
2 properties 2 required
ScimResourceTypeMeta
object
2 properties 2 required
ScimResourceType
object
8 properties 8 required
ScimResourceTypeListResponse
object
5 properties 5 required
ScimSchemaMeta
object
2 properties 2 required
ScimSchemaAttribute
object
12 properties 7 required
ScimSchema
object
6 properties 6 required
ScimSchemaListResponse
object
5 properties 5 required
ApiKey
object
10 properties
ApiKeyHashData
object
3 properties
OrganizationQuota
object
7 properties 6 required
ServiceProfile
object
3 properties
ActiveBalance
object
6 properties
ActiveBalances
object
2 properties
CreditBalance
object
7 properties
CreditBalances
object
2 properties
ServiceClickhouseSetting
object
2 properties
ServiceClickhouseSettingsList
object
1 property
ServiceClickhouseSettingWarning
object
2 properties
ServiceClickhouseSettingsPatchResponse
object
2 properties
ServiceClickhouseSettingSchemaEntry
object
7 properties
ServiceClickhouseSettingsSchema
object
1 property
pgConfig
object
Postgres [runtime configuration](https://www.postgresql.org/docs/current/runtime-config.html) configuration.
31 properties
pgBouncerConfig
object
PgBouncer [runtime configuration](https://www.pgbouncer.org/config.html) configuration.
pgStorageSize
integer
The storage size, in GiB, which must be supported by the specified size.
pgSize
string
The VM size for a Postgres service.
pgHaType
string
Type of high availability: “none” for no replication, “async” for asynchronous replication to a single standby, and “sync” for synchronous replication to two s…
pgProvider
string
The cloud provider for a Postgres service.
pgRegion
string
The cloud region for a Postgres service.
pgVersion
string
pgTags
array
Tags associated with the Postgres service. Tag keys starting with “chc” are reserved for internal use.
pgNameProperty
string
Name of the Postgres service. Alphanumerical string with whitespaces up to 50 characters.
pgIdProperty
string
pgStateProperty
string
Current state of the service
pgIsPrimaryProperty
boolean
True if this service is the primary service in the data warehouse
pgCreatedAtProperty
string
BasePostgresService
object
7 properties
PostgresService
object
16 properties
PostgresServicePostRequest
object
9 properties 4 required
PostgresServicePatchRequest
object
4 properties
pgPitrRestoreTargetProperty
string
The point in time at which to recover, as either date/time, named restore point, or a specific transaction ID.
pgPassword
string
Optional password. If not provided a new password is generated and provided in the response. Must contain: At least one lowercase letter At least one uppercase…
PostgresServiceRestoreRequest
object
5 properties 2 required
PostgresServiceSetPassword
object
1 property
PostgresServicePasswordResource
object
1 property
PostgresServiceListItem
object
11 properties
PostgresServiceSetState
object
1 property
PostgresServiceReadReplicaRequest
object
4 properties 1 required
postgresInstanceConfig
object
2 properties 2 required
postgresInstanceUpdateConfigResponse
object
3 properties 2 required
PostgresMetricDataPoint
object
2 properties 2 required
PostgresMetricSeries
object
2 properties 2 required
PostgresMetric
object
5 properties 5 required
PostgresMetrics
object
1 property 1 required
PostgresSlowQueryPattern
object
19 properties 19 required
PostgresQueryExecution
object
43 properties 38 required
PostgresSlowQueryPatternDetail
object
2 properties 1 required
PostgresLogEntry
object
3 properties 3 required
UpgradeWindow
object
3 properties 3 required
UpgradeWindowPutRequest
object
2 properties 2 required
OrganizationPatchRequest
object
3 properties
InstanceServiceQueryApiEndpointsPostRequest
object
3 properties
ServicePostResponse
object
2 properties
ServicePostRequest
object
30 properties
ServicePatchRequest
object
8 properties
ServiceStatePatchRequest
object
1 property
ServiceScalingPatchRequest
object
5 properties
ServiceScalingPatchResponse
object
40 properties 2 required
ServiceReplicaScalingPatchRequest
object
8 properties
ServicePasswordPatchResponse
object
1 property
ServicePasswordPatchRequest
object
2 properties
ServicPrivateEndpointePostRequest
object
2 properties
ServiceClickhouseSettingsPatchRequest
object
1 property 1 required
BackupConfigurationPatchRequest
object
3 properties
ApiKeyPostResponse
object
3 properties
ApiKeyPostRequest
object
7 properties
ApiKeyPatchRequest
object
6 properties
MemberPatchRequest
object
2 properties
InvitationPostRequest
object
3 properties
ClickPipePostRequest
object
6 properties
ClickPipeSchemaDiscoveryRequest
object
1 property
ClickPipePatchRequest
object
5 properties
ClickPipeScalingPatchRequest
object
4 properties
ClickPipeStatePatchRequest
object
1 property
ClickPipesCdcScalingPatchRequest
object
2 properties
ByocInfrastructurePostRequest
object
5 properties
ByocInfrastructurePatchRequest
object
1 property
UdfCreateRequest
object
UdfVersionCreateRequest
object
Pagination
object
4 properties 4 required
UdfAttachment
object
4 properties 4 required
UdfAttachmentListResponse
object
2 properties 2 required
Udf
object
21 properties 21 required
UdfListResponse
object
2 properties 2 required
UdfUploadSession
object
3 properties 3 required
UdfVersionListResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clickhouse-cloud-api-openapi.json Raw ↑

Other APIs ClickHouse publishes across the network.

ClickHouse HTTP Interface
AE Profile APIs.io
ClickHouse Native TCP Interface
AE Profile APIs.io
ClickHouse MySQL Interface
AE Profile APIs.io
ClickHouse PostgreSQL Interface
AE Profile APIs.io
ClickHouse gRPC Interface
AE Profile APIs.io
ClickHouse ClickHouse HTTP Interface API
AE Profile APIs.io
ClickHouse Ping API
AE Profile APIs.io
ClickHouse Play API
AE Profile APIs.io
ClickHouse Replicas Status API
AE Profile APIs.io
#Cloud#Control Plane#Provisioning#Billing#Observability
← Back to C APIs
API Details
ID
clickhouse:clickhouse-cloud-api
Base URL
https://api.clickhouse.cloud/v1
Docs
https://clickhouse.com/docs/cloud/manage/api/api-overview
Provider
ClickHouse
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=clickhouse-cloud-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/clickhouse-cloud-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ClickHouse Cloud API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.