Skip to content
Changelog

Report a bug

ClickHouse integration: operations for AI agents

ClickHouse connects to Type.com as an integration. This page lists the 174 operations documented for Claude and Codex in Type.com: 88 read, 38 write, 48 destructive.

About ClickHouse

ClickHouse Cloud control-plane reference operations, subject to Type setup and account permissions.

Categories: Developer Tools & IT

How to connect ClickHouse to Type.com

Connect
Configure cloud API target and authentication setup.
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

174 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

174 operations listed.

User management

  • Read

    Resolve the caller identity

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the identity of the authenticated caller. For a user (JWT or clickhousectl token) the result carries the user fields; for an organization API key it carries the key fields instead. Use `actorType` to tell the two apart.

    GET /v1/whoami

  • Read

    List organization members

    Returns a list of all members in the organization.

    GET /v1/organizations/{organizationId}/members

  • Read

    Get member details

    Returns a single organization member details.

    GET /v1/organizations/{organizationId}/members/{userId}

  • Read

    List all invitations

    Returns list of all organization invitations.

    GET /v1/organizations/{organizationId}/invitations

  • Read

    Get invitation details

    Returns details for a single organization invitation.

    GET /v1/organizations/{organizationId}/invitations/{invitationId}

  • Write

    Update organization member

    Updates organization member role.

    PATCH /v1/organizations/{organizationId}/members/{userId}

  • Write

    Create an invitation

    Creates organization invitation.

    POST /v1/organizations/{organizationId}/invitations

  • Destructive

    Remove an organization member

    Removes a user from the organization

    DELETE /v1/organizations/{organizationId}/members/{userId}

  • Destructive

    Delete organization invitation

    Deletes a single organization invitation.

    DELETE /v1/organizations/{organizationId}/invitations/{invitationId}

Organization

  • Read

    Get list of available organizations

    Returns the organizations available to the caller, oldest first. An API key resolves to the single organization it belongs to; a user token returns every organization the user is a member of. Results are capped at `limit` (default 250) per page; the server may return fewer and caps the value at its own maximum. Every response carries `limit` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null.

    GET /v1/organizations

  • Read

    Get organization details

    Returns details of a single organization. In order to get the details, the auth key must belong to the organization.

    GET /v1/organizations/{organizationId}

  • Read

    Get organization quotas

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the resource quotas enforced for the organization together with their current usage where available. Quotas that do not apply to the organization are omitted. Quota values reflect the limits currently enforced, so they can be polled to detect changes, for example after a billing status change. The response contains one entry per quota code; quotas enforced per resource may additionally appear under resource-scoped endpoints in the future.

    GET /v1/organizations/{organizationId}/quotas

  • Read

    Get organization quota details

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns a single organization quota identified by its quota code. Responds with a not found error when the quota code is unknown or the quota does not apply to the organization.

    GET /v1/organizations/{organizationId}/quotas/{quotaCode}

  • Read

    List of organization activities

    Returns a list of all organization activities.

    GET /v1/organizations/{organizationId}/activities

  • Read

    Organization activity

    Returns a single organization activity by ID.

    GET /v1/organizations/{organizationId}/activities/{activityId}

  • Read

    Get private endpoint configuration for region within cloud provider for an organization (deprecated)

    Deprecated. Please follow [documentation](https://clickhouse.com/docs/manage/security/aws-privatelink#add-endpoint-id-to-services-allow-list) for the updated process.

    GET /v1/organizations/{organizationId}/privateEndpointConfig

  • Read

    Validate BYOC infrastructure prerequisites

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Preflight-validates that a cloud account is ready for BYOC infrastructure creation: simulates the cloud permissions ClickHouse needs (and, for BYO-VPC, checks the provided network resources) without creating anything. Takes the same parameters as infrastructure creation, so a payload that passes validation will not be rejected by create for the same inputs.

    POST /v1/organizations/{organizationId}/byocInfrastructure/validate

  • Read

    Get BYOC infrastructure details

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the full configuration of a BYOC infrastructure, including private link and load balancer state, network layout, and BYO-VPC settings read from the data plane.

    GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}

  • Read

    Get BYOC infrastructure provisioning progress

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the stage-by-stage provisioning progress of a BYOC infrastructure, more granular than the `state` field: overall status plus a tree of provisioning stages down to individual cloud resources.

    GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress

  • Read

    Get BYOC infrastructure tags

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the additional tags currently applied to the cloud resources of the BYOC infrastructure. Tags are replaced as a whole through the infrastructure update endpoint.

    GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/tags

  • Read

    Get BYOC infrastructure private endpoint configuration

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the private link endpoint service details of a BYOC infrastructure. For BYOC organizations this replaces the deprecated organization-level `privateEndpointConfig` endpoint.

    GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/privateEndpointConfig

  • Write

    Create BYOC Infrastructure

    Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure

    POST /v1/organizations/{organizationId}/byocInfrastructure

  • Destructive

    Update organization details

    Updates organization fields. Requires ADMIN auth key role.

    PATCH /v1/organizations/{organizationId}

  • Destructive

    Remove a BYOC infrastructure

    Removes a BYOC Infrastructure from the organization

    DELETE /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}

  • Destructive

    Update BYOC Infrastructure

    Update configuration of the BYOC infrastructure: rename it, toggle private link and load balancers, or replace its tags. The request is validated as a whole before anything is applied. If applying a field then fails in the data plane, client errors name the fields already applied, while internal errors return a generic message; retrying the same request is safe either way and converges the infrastructure to the requested state. Returns the modified infrastructure

    PATCH /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}

Prometheus

  • Read

    Get organization metrics (deprecated)

    **Deprecated.** This endpoint is disabled on 1 January 2027. It is already disabled for new organizations. Migrate before then to the service discovery endpoint, `GET /v1/organizations/{organizationId}/prometheus/discovery`. It returns one scrape target per service in the [`http_sd`](https://prometheus.io/docs/prometheus/latest/http_sd/) format, and Prometheus picks up new and deleted services automatically. The [Prometheus integration guide](https://clickhouse.com/docs/integrations/prometheus) has a `prometheus.yml` example. If you need this endpoint after 1 January 2027, contact ClickHouse support to have it enabled for your organization. Returns Prometheus metrics for the services in the organization. Only services the API key is authorized to view are included.

    GET /v1/organizations/{organizationId}/prometheus

  • Read

    Get Prometheus service discovery targets

    Returns one Prometheus scrape target per service in the organization, in the [HTTP service discovery](https://prometheus.io/docs/prometheus/latest/http_sd/) (`http_sd`) format. Only services the API key is authorized to view are included; services that are being deleted or have been deleted are omitted. Point an [`http_sd_configs`](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) job at this endpoint to discover and scrape all services in the organization automatically. Prometheus refreshes the target list on every discovery poll, so newly created and deleted services are picked up without configuration changes. Filter targets in `relabel_configs` by `__meta_clickhouse_region`, `__meta_clickhouse_provider` or `__meta_clickhouse_tag_`. Invalid label name characters in tag keys become `_`. `__meta_clickhouse_tagpresent_` is `true` for every tag, including tags without a value. Discovered targets scrape with `filtered_metrics=true` by default; pass `?filtered_metrics=false` to this endpoint to discover unfiltered targets. See the [Prometheus integration guide](https://clickhouse.com/docs/integrations/prometheus) for more on the exported metrics.

    GET /v1/organizations/{organizationId}/prometheus/discovery

  • Read

    Get service metrics

    Returns prometheus metrics for a service.

    GET /v1/organizations/{organizationId}/services/{serviceId}/prometheus

  • Read

    Get organization PostgreSQL metrics

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns Prometheus metrics for all PostgreSQL services in an organization. Maximum 100 services supported.

    GET /v1/organizations/{organizationId}/postgres/prometheus

  • Read

    Get PostgreSQL service metrics

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns Prometheus metrics for a PostgreSQL service.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/prometheus

Role Management

  • Read

    List all available roles for an organization

    Returns all available roles (system + custom) for an organization.

    GET /v1/organizations/{organizationId}/roles

  • Read

    Get role details

    Returns details for a specific role.

    GET /v1/organizations/{organizationId}/roles/{roleId}

  • Write

    Create a new role

    Creates a new custom role for an organization with specified policies and actors.

    POST /v1/organizations/{organizationId}/roles

  • Destructive

    Update a role

    Updates an existing custom role. System roles cannot be updated. All fields are optional - only provided fields will be updated.

    PATCH /v1/organizations/{organizationId}/roles/{roleId}

  • Destructive

    Delete a role

    Deletes an existing custom role. System roles cannot be deleted. This operation will remove the role and all its associated policies.

    DELETE /v1/organizations/{organizationId}/roles/{roleId}

Service

  • Read

    List available service profiles

    Returns the custom instance profiles the organization can use in a region. Pass byoc_id to list the profiles configured for a BYOC infrastructure; the region is then taken from the infrastructure and region_id may be omitted. The list is empty when the organization tier does not include custom hardware profiles.

    GET /v1/organizations/{organizationId}/serviceProfiles

  • Read

    List of organization services

    Returns a list of all services in the organization.

    GET /v1/organizations/{organizationId}/services

  • Read

    Get service details

    Returns a service that belongs to the organization

    GET /v1/organizations/{organizationId}/services/{serviceId}

  • Read

    Get private endpoint configuration

    Information required to set up a private endpoint

    GET /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig

  • Read

    Get the service query endpoint for a given instance

    Get the configuration for the service query endpoint that allows executing queries via API.

    GET /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint

  • Read

    Get service autoscaling schedule

    Returns the autoscaling schedule for a service. Returns 404 if no schedule has been configured or if the schedule was cleared. Requires the scheduled autoscaling feature to be enabled for the organization.

    GET /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule

  • Read

    Get service upgrade window

    Returns the configured upgrade window for a service. Errors: - 401: missing, invalid, or disabled API key. - 403: caller lacks `control-plane:service:view` on the service. - 404: service does not exist, is not visible to the caller, or no upgrade window has been configured.

    GET /v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow

  • Read

    List ClickHouse settings

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the configured ClickHouse settings for the service. Only settings that have been explicitly set are included.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings

  • Read

    Get ClickHouse settings schema

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the schema of all configurable ClickHouse settings, including types, valid values, descriptions, and warnings.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema

  • Read

    Get ClickHouse setting

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the current value of a ClickHouse setting for the service. Use the [schema endpoint](#tag/Service/operation/serviceClickhouseSettingsSchemaGet) to discover which settings are configurable.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName}

  • Read

    Get replica aware routing

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns whether replica aware routing (sticky routing) is enabled for HTTP and native connections on the service.

    GET /v1/organizations/{organizationId}/services/{serviceId}/replicaAwareRouting

  • Write

    Create new service

    Creates a new service in the organization, and returns the current service state and a password to access the service. The service is started asynchronously.

    POST /v1/organizations/{organizationId}/services

  • Write

    Upsert the service query endpoint for a given instance

    Create the service query endpoint that allows executing queries via API.

    POST /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint

  • Write

    Update service auto scaling settings (deprecated)

    Updates minimum and maximum total memory limits and idle mode scaling behavior for the service. The memory settings are available only for "production" services and must be a multiple of 12 starting from 24GB. Please contact support to enable adjustment of numReplicas.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/scaling

  • Write

    Update service auto scaling settings

    Updates minimum and maximum memory limits per replica and idle mode scaling behavior for the service. Supports both vertical autoscaling (fixed replica count, variable memory) and horizontal autoscaling (variable replica count, fixed memory). The memory settings are available only for "production" services and must be a multiple of 4 starting from 8GB. For vertical autoscaling, please contact support to enable adjustment of numReplicas. For horizontal autoscaling (autoscalingMode "horizontal" with minReplicas/maxReplicas), contact support to enable the feature for your organization.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/replicaScaling

  • Write

    Update service password

    Sets a new password for the service

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/password

  • Write

    Create a private endpoint

    Create a new private endpoint. The private endpoint will be associated with this service and organization

    POST /v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint

  • Write

    Update ClickHouse settings

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Updates one or more ClickHouse settings for the service. To reset a setting to its platform default, use the [DELETE single setting](#tag/Service/operation/serviceClickhouseSettingDelete) endpoint. Use the [schema endpoint](#tag/Service/operation/serviceClickhouseSettingsSchemaGet) to discover which settings are configurable.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings

  • Write

    Update replica aware routing

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Updates replica aware routing (sticky routing) for the service. Requires the organization feature to be enabled. Provide at least one of httpEnabled, nativeEnabled; omit a field to leave it unchanged.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/replicaAwareRouting

  • Destructive

    Update service basic details

    Updates basic service details like service name or IP access list.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}

  • Destructive

    Delete service

    Deletes the service. The service must be in stopped state and is deleted asynchronously after this method call.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}

  • Destructive

    Delete the service query endpoint for a given instance

    Removes the service query endpoint.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint

  • Destructive

    Update service state

    Starts, stops, or wakes a service. The `start` and `stop` commands require the `control-plane:service:manage` permission on the service. The `awake` command requires only `control-plane:service:view` and applies to an idle service; it does not start a stopped service.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/state

  • Destructive

    Create or replace service autoscaling schedule

    Creates or fully replaces the autoscaling schedule for a service. Pass an empty `entries` array to clear the schedule — a subsequent GET will return 404, and the response will contain an empty `baseConfig` (all fields absent). The base scaling config (applied when no entry is active) is managed separately via the `replicaScaling` endpoint. Requires the scheduled autoscaling feature to be enabled for the organization.

    POST /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule

  • Destructive

    Delete service scheduled scaling

    Deletes the autoscaling schedule for a service. If a schedule entry is currently active, the base scaling config is restored to the instance before the schedule is removed. Returns 404 if no schedule exists. Requires the scheduled autoscaling feature to be enabled for the organization.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/scalingSchedule

  • Destructive

    Set service upgrade window

    Creates or fully replaces the upgrade window for a service. The upgrade window currently lasts 6 hours from `startHourUtc`. The upgrade window can only be set on primary services; secondary services inherit the primary service window. Errors: - 400: invalid field values (`weekday` not in 0–6, `startHourUtc` not in {0, 6, 12, 18}), or the service is a secondary service. - 401: missing, invalid, or disabled API key. - 403: caller lacks `control-plane:service:manage` on the service, or the organization does not have the scheduled upgrades feature enabled. - 404: service does not exist or is not visible to the caller.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow

  • Destructive

    Delete service upgrade window

    Deletes the upgrade window for a service, restoring the default scheduling behaviour. The upgrade window can only be deleted on primary services. Deletion succeeds even if the organization has lost the scheduled upgrades entitlement, so a window can be cleared after entitlement loss. Errors: - 400: the service is a secondary service. - 401: missing, invalid, or disabled API key. - 403: caller lacks `control-plane:service:manage` on the service. - 404: service does not exist, is not visible to the caller, or no upgrade window is configured.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow

  • Destructive

    Reset ClickHouse setting to default

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Removes a previously-configured ClickHouse setting, reverting its effective value to the platform default. Settings under `spec.extraConfig.server.*` (e.g. `keep_alive_timeout`, `shared_merge_tree_disable_merges_and_mutations_assignment`) trigger a ClickHouse server rollout restart; other settings propagate to all replicas after a short delay. Deleting a setting that was never configured is a no-op (200 OK).

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName}

Backup

  • Read

    List of service backups

    Returns a list of all backups for the service. The most recent backups comes first in the list.

    GET /v1/organizations/{organizationId}/services/{serviceId}/backups

  • Read

    Get backup details

    Returns a single backup info.

    GET /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}

  • Read

    Get service backup configuration

    Returns the service backup configuration.

    GET /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration

  • Read

    Get service backup bucket

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the service backup bucket.

    GET /v1/organizations/{organizationId}/services/{serviceId}/backupBucket

  • Write

    Create service backup bucket

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Create service backup bucket. Requires ADMIN auth key role.

    POST /v1/organizations/{organizationId}/services/{serviceId}/backupBucket

  • Destructive

    Update service backup configuration

    Updates service backup configuration. Requires ADMIN auth key role. Setting the properties with null value, will reset the properties to theirs default values.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration

  • Destructive

    Update service backup bucket

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update service backup bucket. Requires ADMIN auth key role. The secrets of the specified bucket provider are always required

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupBucket

  • Destructive

    Delete service backup bucket

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Delete service backup bucket. Requires ADMIN auth key role.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/backupBucket

Snapshot

  • Read

    List of service snapshots

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a list of snapshots for the service, most recent first. Results are capped at `limit` (default 250) per page; the server may return fewer and caps the value at its own maximum. Every response carries `limit`, `totalCount` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null.

    GET /v1/organizations/{organizationId}/services/{serviceId}/snapshots

  • Read

    Get snapshot details

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a single snapshot info.

    GET /v1/organizations/{organizationId}/services/{serviceId}/snapshots/{snapshotId}

  • Read

    Get service snapshot configuration

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the service snapshot configuration.

    GET /v1/organizations/{organizationId}/services/{serviceId}/snapshotConfiguration

  • Destructive

    Update service snapshot configuration

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Updates the service snapshot configuration. Requires ADMIN auth key role. Enables or disables scheduled snapshots and sets the cadence; when enabled, gap and timeFrame (in minutes) must together be one of the supported (gap, timeFrame) pairs: (30, 1440), (60, 2880). Provide at least one of enabled, gap, timeFrame; omit a field to leave it unchanged (null is not accepted). Enabling snapshots or changing the cadence requires an eligible organization (see the organization's capabilities.snapshots).

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/snapshotConfiguration

API keys

  • Read

    Get list of keys

    Returns a list of keys in the organization, ordered by creation date, oldest first. Results are capped at `limit` (default 250) per page; the server may return fewer and caps the value at its own maximum. Every response carries `limit`, `totalCount` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null.

    GET /v1/organizations/{organizationId}/keys

  • Read

    Get key details

    Returns a single key details.

    GET /v1/organizations/{organizationId}/keys/{keyId}

  • Write

    Create key

    Creates new API key.

    POST /v1/organizations/{organizationId}/keys

  • Destructive

    Update key

    Updates API key properties.

    PATCH /v1/organizations/{organizationId}/keys/{keyId}

  • Destructive

    Delete key

    Deletes API key. Only a key not used to authenticate the active request can be deleted.

    DELETE /v1/organizations/{organizationId}/keys/{keyId}

Notifications

  • Read

    List of organization notifications

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns notifications for the organization, most recent first. Only notifications about resources the caller can access are returned, so two keys in the same organization can see different results. The [notification types endpoint](#tag/Notifications/operation/notificationTypesGetList) lists the types this organization can receive, so it shows what to expect here. Notifications are retained for 180 days. A page holds at most `limit` notifications (default 100, maximum 250; a larger value is clamped) and the server may return fewer. Every response carries `limit` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null.

    GET /v1/organizations/{organizationId}/notifications

  • Read

    List notification types

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns every notification type the organization is entitled to, each flagged with whether the caller may use it. Types the organization is not entitled to are omitted; types the caller lacks permission to use are returned with `isAvailable` set to false. Every type supports the `ui`, `email` and `slack` channels, so channels are a property of the API rather than of a type. The effective delivery default is a function of type, role and channel, so no per-type default is reported here.

    GET /v1/organizations/{organizationId}/notificationTypes

Billing

  • Read

    Get organization usage costs

    Returns a grand total and a list of daily, per-entity organization usage cost records for the organization in the queried time period (maximum 31 days). All days in both the request and the response are evaluated based on the UTC timezone.

    GET /v1/organizations/{organizationId}/usageCost

  • Read

    Get organization active prepaid balances (deprecated)

    DEPRECATED. Use the `/v1/organizations/{organizationId}/creditBalances` endpoint instead. Returns the active prepaid credit balances for the organization, each with its own balance ID and remaining credits, along with the total remaining credits across all active balances. A balance is active when it has started, has not expired, and has credits remaining. Balances are ordered by expiration date, soonest first, and the returned page is capped at `limit` (default and maximum 100). When `totalCount` exceeds the number of returned balances, page with `limit`/`offset` to retrieve them all. `totalRemainingPrepaidCredits` always covers every active balance, not just the returned page.

    GET /v1/organizations/{organizationId}/activeBalances

  • Read

    Get organization active credit balances

    **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the active credit balances for the organization, each with its own balance ID, type and remaining credits, along with the total remaining credits across all of them. A balance is active when it has started, has not expired, and has credits remaining. Balances are ordered by expiration date, soonest first. The list is always present and is empty when the organization has no active balances.

    GET /v1/organizations/{organizationId}/creditBalances

ClickPipes

  • Read

    List ClickPipes

    Returns a list of ClickPipes.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes

  • Read

    Get ClickPipes service context

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns service-level ClickPipes capabilities and Private Preview workload identity context, including the GCP service account to grant access to customer source resources.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/context

  • Read

    Get ClickPipe

    Returns the specified ClickPipe.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}

  • Read

    Get ClickPipe settings

    Returns the advanced settings for the specified ClickPipe.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings

  • Read

    Discover ClickPipe source schema

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Infers the schema (field names and ClickHouse data types) of a ClickPipe source without creating a pipe. Supported for Kafka, Kinesis, Pub/Sub, and object storage sources. Object storage inference runs on the destination service, which must be running.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/schemaDiscovery

  • Read

    Get CDC ClickPipes scaling

    Get scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery). The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit. **Note:** For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet). **This endpoint becomes available once at least one database ClickPipe was provisioned.**

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling

  • Read

    List reverse private endpoints

    Returns a list of reverse private endpoints for the specified service.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints

  • Read

    Get reverse private endpoint

    Returns the reverse private endpoint with the specified ID.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}

  • Write

    Update ClickPipe settings

    Update the advanced settings for the specified ClickPipe. Send key-value pairs where values can be strings, numbers, or booleans.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings

  • Write

    Update ClickPipe scaling

    Change scaling settings for the specified ClickPipe. This endpoint supports Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob). **Note:** For database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery), use the [Update CDC ClickPipes scaling](#tag/ClickPipes/operation/clickPipeCdcScalingUpdate) endpoint instead.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling

  • Write

    Update CDC ClickPipes scaling

    Update scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery). The infrastructure is shared between all database ClickPipes in the service, both for initial load and CDC. Scaling settings may take a few minutes to fully propagate. For billing purposes, 2 CPU cores and 8 GB of RAM [correspond](https://clickhouse.com/docs/cloud/manage/billing/overview#clickpipes-for-postgres-cdc) to one compute unit. If your organization tier changes, database ClickPipes will be [rescaled](https://clickhouse.com/docs/cloud/manage/billing/overview#compute) appropriately. **Note:** For Kafka, Kinesis, and object storage pipes (S3, GCS, Azure Blob), see [Get ClickPipe](#tag/ClickPipes/operation/clickPipeGet). **This endpoint becomes available once at least one database ClickPipe was provisioned.**

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling

  • Write

    Create reverse private endpoint

    Create a new reverse private endpoint.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints

  • Destructive

    Create ClickPipe

    Create a new ClickPipe.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickpipes

  • Destructive

    Update ClickPipe

    Update the specified ClickPipe. Source fields not present in the per-source update schemas are immutable after creation. For Kafka sources, values submitted for immutable fields (type, format, brokers, topics, consumerGroup, offset, schemaRegistry, exactlyOnce, tombstoneMode) are not applied, except schema registry credentials, which are rejected.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}

  • Destructive

    Delete ClickPipe

    Delete the specified ClickPipe.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}

  • Destructive

    Update ClickPipe state

    Start, stop or resync ClickPipe. Stopping a ClickPipe will stop the ingestion process from any state. Starting is allowed for ClickPipes in the "Stopped" state or with a "Failed" state. Resyncing is only for Postgres and MySQL pipes and can be done from any state.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state

  • Destructive

    Delete reverse private endpoint

    Delete the reverse private endpoint with the specified ID.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}

  • Destructive

    Update reverse private endpoint

    Update mutable fields for an existing reverse private endpoint. customPrivateDnsMappings is a full replacement list. Use an empty array to clear mappings.

    PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}

ClickStack

  • Read

    ClickStack: List Dashboards

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a list of all dashboards for the authenticated team

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards

  • Read

    ClickStack: Get Dashboard

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific dashboard by ID

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}

  • Read

    ClickStack: Validate Dashboard

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Validates a dashboard body against the same schema and tile rules used by POST /api/v2/dashboards. The dashboard is **never persisted**. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a dashboard configuration is valid before applying it.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/validate

  • Read

    ClickStack: List Alerts

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves alerts for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When `totalCount` exceeds the number of returned items, page with `limit`/`offset` to retrieve them all.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts

  • Read

    ClickStack: List Sources

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a list of all sources for the authenticated team

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources

  • Read

    ClickStack: Get Source

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific source by ID

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}

  • Read

    ClickStack: Get Alert

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific alert by ID

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}

  • Read

    ClickStack: List Webhooks

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves webhooks for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When `totalCount` exceeds the number of returned items, page with `limit`/`offset` to retrieve them all.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks

  • Read

    ClickStack: Validate Webhook

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Validates a webhook body against the same schema, URL rules, and body template check used by POST /api/v2/webhooks. The webhook is **never persisted**. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a webhook configuration is valid before applying it. Name uniqueness is not checked.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/validate

  • Read

    ClickStack: List Roles

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves all roles for the authenticated team, including predefined roles.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles

  • Read

    ClickStack: Get Role

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific role by ID.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}

  • Read

    ClickStack: List Saved Searches

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves saved searches for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When `totalCount` exceeds the number of returned items, page with `limit`/`offset` to retrieve them all.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches

  • Read

    ClickStack: Get Saved Search

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific saved search by ID.

    GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}

  • Write

    ClickStack: Create Dashboard

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new dashboard

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards

  • Write

    ClickStack: Create Alert

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new alert

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts

  • Write

    ClickStack: Create Source

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new source. The request body is a source object without the `id` field. If an `id` is sent anyway it is silently ignored (stripped before validation — the request is never rejected because of it). Granularity fields (`materializedViews[].minGranularity` and `metadataMaterializedViews.granularity`) accept the same short format the API returns (e.g. `5m`, `15s`, `1h`, `1d`).

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources

  • Write

    ClickStack: Update Alert

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing alert

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}

  • Write

    ClickStack: Create Webhook

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new webhook for the authenticated team.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks

  • Write

    ClickStack: Create Role

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new custom role for the team.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles

  • Write

    ClickStack: Create Saved Search

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new saved search.

    POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches

  • Destructive

    ClickStack: Update Dashboard

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing dashboard. **Concurrency:** This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}

  • Destructive

    ClickStack: Delete Dashboard

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a dashboard

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}

  • Destructive

    ClickStack: Update Source

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing source. The full source object must be provided; this is a replace, not a patch. The request body is a source object without the `id` field. If an `id` is sent anyway it is silently ignored (stripped before validation — never a 400); the path parameter alone identifies the source. Granularity fields (`materializedViews[].minGranularity` and `metadataMaterializedViews.granularity`) accept the same short format the API returns (e.g. `5m`, `15s`, `1h`, `1d`).

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}

  • Destructive

    ClickStack: Delete Source

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a source

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}

  • Destructive

    ClickStack: Delete Alert

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes an alert

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}

  • Destructive

    ClickStack: Update Webhook

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Replaces an existing webhook. Readable optional fields (`description`, `body`) are a full replace: omitting them clears them. The write-only fields `headers` and `queryParams` are never returned on read, so omitting them preserves the stored values; send an explicit empty object (`{}`) to clear them. Exception: if the destination (`url` or `service`) changes, omitted `headers`/ `queryParams` are cleared rather than preserved so stored secrets are never forwarded to a new destination.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}

  • Destructive

    ClickStack: Delete Webhook

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a webhook. Blocked with a 409 while any alert still references it — reassign or remove those alerts first — so deletion never leaves an alert pointing at a missing webhook (which would silently drop notifications). Mirrors the internal webhook delete guard.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}

  • Destructive

    ClickStack: Update Role

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates a custom role's permissions, name, and description. Predefined roles cannot be modified.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}

  • Destructive

    ClickStack: Delete Role

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a custom role. Predefined roles, the team default user role, and roles assigned to users cannot be deleted.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}

  • Destructive

    ClickStack: Update Saved Search

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing saved search. This is a full replace: send the full object. Every optional field (`select`, `where`, `whereLanguage`, `orderBy`, `tags`, `filters`) is always written and falls back to its default when omitted, so omitting a field resets it rather than preserving the stored value.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}

  • Destructive

    ClickStack: Delete Saved Search

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a saved search and any alerts attached to it.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}

Postgres

  • Read

    List of organization Postgres services

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a list of all Postgres services in the organization.

    GET /v1/organizations/{organizationId}/postgres

  • Read

    Get PostgreSQL service details

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a Postgres service that belongs to the organization

    GET /v1/organizations/{organizationId}/postgres/{postgresId}

  • Read

    Get Postgres CA certs

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Download CA certificates for a PostgreSQL service

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/caCertificates

  • Read

    Get PostgreSQL service configuration

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the configuration data for a Postgres service and its PgBouncer service.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/config

  • Read

    Get Postgres time-series metrics

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns bucketed time-series metrics for a PostgreSQL service over the requested window (CPU, memory, disk, network, connections, cache hit ratio, throughput, transactions, wait events, lock waits, and more). Use this to chart or analyze how a service behaved over time.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/metrics

  • Read

    List of Postgres service backups

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a list of the base backups retained for a Postgres service, ordered by last modified date, newest first. Results are capped at `limit` (default and maximum 100) per page. Every response carries `limit`, `totalCount` and `nextCursor`; pass `nextCursor` as the `cursor` query parameter to fetch the next page, repeating until it is null. A Postgres service is recovered to a point in time rather than to a single backup, so restore it with the restore endpoint and a timestamp between the service's `earliestRestoreTime` and now, rather than with a backup key from this list.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/backups

  • Read

    List Postgres slow query patterns

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns aggregate metrics for the slowest query patterns observed on a Postgres service during the given time window. Use this to discover which queries dominate total execution time, CPU, I/O, or WAL generation.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns

  • Read

    Get a Postgres slow query pattern with recent executions

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns aggregate metrics for a single slow query pattern together with its most recent individual executions.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns/{queryId}

  • Read

    List Postgres server logs

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns PostgreSQL server log entries for a Postgres service within the given time window, most recent first by default (override with `sort_order`). Results are paginated with `limit`/`offset`; advance `offset` until a page returns fewer than `limit` entries to read the full window. The time range must not exceed 30 days, and `to_date` must be after `from_date`.

    GET /v1/organizations/{organizationId}/postgres/{postgresId}/logs

  • Write

    Create new Postgres service

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Creates a new Postgres service in the organization and returns it. The service is started asynchronously.

    POST /v1/organizations/{organizationId}/postgres

  • Write

    Restore a Postgres service

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Restore a Postgres database from continuous backup, optionally at a specific point in time.

    POST /v1/organizations/{organizationId}/postgres/{postgresId}/restoredService

  • Write

    Update Postgres superuser password

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Sets a new password for a Postgres service's superuser account.

    PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/password

  • Write

    Update Postgres service state

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Initiate a process for a Postgres service: * restart: Initiates a service restart * promote: Promotes a read replica to primary * switchover: Switch a primary over to a standby

    PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/state

  • Write

    Create a read replica for a Postgres service

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Initiate the process to create a new read replica for a Postgres service.

    POST /v1/organizations/{organizationId}/postgres/{postgresId}/readReplica

  • Write

    Update Postgres service configuration

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update the existing Postgres service and pgBouncer configuration.

    PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/config

  • Destructive

    Delete a PostgreSQL service

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Deletes a Postgres service that belongs to the organization

    DELETE /v1/organizations/{organizationId}/postgres/{postgresId}

  • Destructive

    Update a PostgreSQL service

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update a Postgres service that belongs to the organization. **WARNING:** Changing the name also updates the host name and certificates for the service.

    PATCH /v1/organizations/{organizationId}/postgres/{postgresId}

  • Destructive

    Replace Postgres service configuration

    **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Replace the existing Postgres service and pgBouncer configuration.

    POST /v1/organizations/{organizationId}/postgres/{postgresId}/config

Query API endpoints

  • Read

    List Query API endpoints

    Returns all active Query API endpoints for the service.

    GET /v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints

  • Read

    Get a Query API endpoint

    Returns a Query API endpoint.

    GET /v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints/{endpointId}

  • Write

    Create a Query API endpoint

    Creates a Query API endpoint.

    POST /v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints

  • Write

    Update a Query API endpoint

    Updates a Query API endpoint.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints/{endpointId}

  • Destructive

    Delete a Query API endpoint

    Deletes a Query API endpoint.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints/{endpointId}

Saved queries

  • Read

    List saved queries

    Returns saved queries for the service.

    GET /v1/organizations/{organizationId}/services/{serviceId}/saved-queries

  • Read

    Get a saved query

    Returns a saved query.

    GET /v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}

  • Write

    Create a saved query

    Creates a saved query.

    POST /v1/organizations/{organizationId}/services/{serviceId}/saved-queries

  • Write

    Update a saved query

    Updates a saved query.

    PUT /v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}

  • Destructive

    Delete a saved query

    Deletes a saved query.

    DELETE /v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}

UDF

  • Read

    List UDFs

    Returns the latest version of each UDF in the organization.

    GET /v1/organizations/{organizationId}/udfs

  • Read

    Get UDF

    Returns the latest version of a UDF.

    GET /v1/organizations/{organizationId}/udfs/{functionName}

  • Read

    List UDF attachments

    Returns the current service attachments for a UDF, with at most one attachment per service.

    GET /v1/organizations/{organizationId}/udfs/{functionName}/attachments

  • Read

    Get UDF attachment

    Returns the current attachment of a UDF to one service.

    GET /v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}

  • Read

    List UDF versions

    Returns all versions of a UDF.

    GET /v1/organizations/{organizationId}/udfs/{functionName}/versions

  • Write

    Create UDF upload URL

    Creates an org-scoped presigned application/zip upload URL. Callers must use an upload ID for only one create or version attempt and request a new upload URL when retrying.

    POST /v1/organizations/{organizationId}/udfUploads/url

  • Write

    Create UDF

    Creates a new UDF. See [User-defined functions in Cloud](https://clickhouse.com/docs/products/cloud/features/sql-console-features/user-defined-functions).

    POST /v1/organizations/{organizationId}/udfs

  • Write

    Create UDF version

    Consumes a source archive, assigns a version, and starts the UDF build. Optional configuration fields omitted from the request use the defaults documented in the request schema; values are not inherited from the previous version. Retry by requesting a new upload URL and re-uploading.

    POST /v1/organizations/{organizationId}/udfs/{functionName}/versions

  • Destructive

    Delete UDF

    Deletes every version of a UDF and detaches it from all services. Removal from services completes asynchronously.

    DELETE /v1/organizations/{organizationId}/udfs/{functionName}

  • Destructive

    Detach UDF from service

    Detaches a UDF from a service.

    DELETE /v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}

  • Destructive

    Attach UDF to service

    Attaches one UDF version to a service, replacing the current version when necessary. When version is omitted, the latest ready version is attached.

    PUT /v1/organizations/{organizationId}/udfs/{functionName}/attachments/{serviceId}

  • Destructive

    Delete UDF version

    Deletes a UDF version. The UDF must not be attached to any services.

    DELETE /v1/organizations/{organizationId}/udfs/{functionName}/versions/{version}

See How connections work for access and permissions, or browse all integrations.