---
title: "[BETA] Get a DBaaS ClickHouse service"
method: GET
path: "/dbaas-clickhouse/{name}"
tags: ["dbaas"]
---

# \[BETA\] Get a DBaaS ClickHouse service

`GET /dbaas-clickhouse/{name}`

## Request

- Base URL: `https://api-ch-gva-2.exoscale.com/v2`
- URL: `https://api-ch-gva-2.exoscale.com/v2/dbaas-clickhouse/{name}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/exoscale/apis/exoscale-api/docs/dbaas-clickhouse/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `name` string, required

## Response `200`

200

- DbaasServiceClickhouse
  - `updated-at` string, date-time: Service last update timestamp (ISO 8601)
  - `node-count` integer: Number of service nodes in the active plan
  - `connection-info` object: ClickHouse connection information properties
    - `uri` string[]
    - `mysql-uri` string
    - `arrowflight-uri` string
  - `node-cpu-count` integer: Number of CPUs for each node
  - `prometheus-uri` object, required: Prometheus integration URI
    - `host` string
    - `port` integer
  - `integrations` DbaasIntegration[]: Service integrations
    - `description` string: Description of the integration
    - `settings` object: Integration settings
    - `type` string: Integration type
    - `is-enabled` boolean: Whether the integration is enabled or not
    - `source` string: Source service name
    - `is-active` boolean: Whether the integration is active or not
    - `status` string: Integration status
    - `id` string, uuid: Integration id
    - `dest` string: Destination service name
  - `zone` string: The zone where the service is running
  - `node-states` DbaasNodeState[]: State of individual service nodes
    - `name` string, required: Name of the service node
    - `progress-updates` DbaasNodeStateProgressUpdate[]: Extra information regarding the progress for current state
      - `completed` boolean, required: Indicates whether this phase has been completed or not
      - `current` integer: Current progress for this phase. May be missing or null.
      - `max` integer: Maximum progress value for this phase. May be missing or null. May change.
      - `min` integer: Minimum progress value for this phase. May be missing or null.
      - `phase` 'stream' | 'basebackup' | 'prepare' | 'finalize', required: Key identifying this phase
      - `unit` string: Unit for current/min/max values. New units may be added. If null should be treated as generic unit
    - `role` 'standby' | 'master' | 'read-replica': Role of this node. Only returned for a subset of service types
    - `state` 'leaving' | 'running' | 'syncing_data' | 'setting_up_vm' | 'unknown', required: Current state of the service node
  - `name` string, required
  - `type` string, required
  - `state` 'running' | 'rebuilding' | 'rebalancing' | 'poweroff'
  - `ip-filter` string[]: Allowed CIDR address blocks for incoming connections
  - `backups` DbaasServiceBackup[]: List of backups for the service
    - `backup-name` string, required: Internal name of this backup
    - `backup-time` string, date-time, required: Backup timestamp (ISO 8601)
    - `data-size` integer, required: Backup's original size before compression
  - `termination-protection` boolean: Service is protected against termination and powering off
  - `clickhouse-settings` JsonSchemaClickhouse
    - `server_settings` object: ClickHouse server settings, which can be found in the `system.server_settings` table.
      - `vector_similarity_index_cache_size` number: Fraction of total server memory allocated to the vector similarity index cache. 0 disables the cache. Default is 0.07 (7% of server memory). Only effective on ClickHouse 25.8+.
    - `tiered_storage_move_factor` number: The percentage of free disk space required on local storage before data is moved to object storage. A value of 0.2 means data is moved when local storage has less than 20% free space.
  - `notifications` DbaasServiceNotification[]: Service notifications
    - `level` 'warning' | 'notice', required: Notification level
    - `message` string, required: Human notification message
    - `type` 'service_powered_off_removal' | 'service_end_of_life', required: Notification type
    - `metadata` object, required: Notification type
  - `components` object[]: Service component information objects
    - `component` string, required: Service component name
    - `host` string, required: DNS name for connecting to the service component
    - `port` integer, required: Port number for connecting to the service component
    - `route` 'dynamic' | 'private' | 'public' | 'privatelink', required
    - `ssl` boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components that may disable encryption.
    - `usage` 'primary' | 'replica', required
  - `maintenance` DbaasServiceMaintenance: Automatic maintenance settings
    - `dow` 'saturday' | 'tuesday' | 'never' | 'wednesday' | 'sunday' | 'friday' | 'monday' | 'thursday', required: Day of week for installing updates
    - `time` string, required: Time for installing updates, UTC
    - `updates` DbaasServiceUpdate[], required: List of updates waiting to be installed
      - `description` string: Description of the update
      - `deadline` string, date-time: Deadline for installing the update
      - `start-after` string, date-time: The earliest time the update will be automatically applied
      - `start-at` string, date-time: The time when the update will be automatically applied
  - `disk-size` integer: TODO UNIT disk space for data storage
  - `node-memory` integer: TODO UNIT of memory for each node
  - `uri` string: URI for connecting to the service (may be absent)
  - `uri-params` object: service_uri parameterized into key-value pairs
  - `version` string: ClickHouse version
  - `created-at` string, date-time: Service creation timestamp (ISO 8601)
  - `plan` string, required: Subscription plan
  - `users` DbaasClickhouseUser[]: List of ClickHouse users
    - `username` string, required
    - `uuid` string, uuid
    - `required` boolean

## Changes

- **2026-11-06** `63da6f74c845`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/dbaas-clickhouse/:name/get.md)

---

[API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)