Path parameters

• name string Required

  Minimum length is 0, maximum length is 63.

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • updated-at string(date-time)

    Service last update timestamp (ISO 8601)

  • node-count integer(int64)

    Number of service nodes in the active plan

    Minimum value is 0.

  • connection-info object

    ClickHouse connection information properties

    Hide connection-info attributes Show connection-info attributes object

    • uri array[string]
    • mysql-uri string
    • arrowflight-uri string
  • node-cpu-count integer(int64)

    Number of CPUs for each node

    Minimum value is 0.

  • prometheus-uri object Required

    Prometheus integration URI

    Hide prometheus-uri attributes Show prometheus-uri attributes object

    • host string
    • port integer(int64)

      Minimum value is 0, maximum value is 65535.

  • integrations array[object]

    Service integrations

    Hide integrations attributes Show integrations attributes object

    • 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 array[object]

    State of individual service nodes

    Hide node-states attributes Show node-states attributes object

    Automatic maintenance settings

    • name string Required

      Name of the service node

    • progress-updates array[object]

      Extra information regarding the progress for current state

      Hide progress-updates attributes Show progress-updates attributes object

      Extra information regarding the progress for current state

      • completed boolean Required

        Indicates whether this phase has been completed or not

      • current integer(int64)

        Current progress for this phase. May be missing or null.

        Minimum value is 0.

      • max integer(int64)

        Maximum progress value for this phase. May be missing or null. May change.

        Minimum value is 0.

      • min integer(int64)

        Minimum progress value for this phase. May be missing or null.

        Minimum value is 0.

      • phase string Required

        Key identifying this phase

        Values are stream, basebackup, prepare, or finalize.

      • unit string

        Unit for current/min/max values. New units may be added. If null should be treated as generic unit

    • role string

      Role of this node. Only returned for a subset of service types

      Values are standby, master, or read-replica.

    • state string Required

      Current state of the service node

      Values are leaving, running, syncing_data, setting_up_vm, or unknown.

  • name string Required

    Service name

    Minimum length is 0, maximum length is 63.

  • type string Required

    Service type code

    Minimum length is 0, maximum length is 64.

  • state string

    State of the service

    Values are running, rebuilding, rebalancing, or poweroff.

  • ip-filter array[string]

    Allowed CIDR address blocks for incoming connections

  • backups array[object]

    List of backups for the service

    Hide backups attributes Show backups attributes object

    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(int64) Required

      Backup's original size before compression

      Minimum value is 0.

  • termination-protection boolean

    Service is protected against termination and powering off

  • clickhouse-settings object

    ClickHouse-specific settings

    Hide clickhouse-settings attribute Show clickhouse-settings attribute object

    • server_settings object

      ClickHouse server settings, which can be found in the system.server_settings table.

      Additional properties are NOT allowed.

      Hide server_settings attribute Show server_settings attribute object

      • 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+.

        Minimum value is 0, maximum value is 0.5. Default value is 0.07.

  • notifications array[object]

    Service notifications

    Hide notifications attributes Show notifications attributes object

    Service notifications

    • level string Required

      Notification level

      Values are warning or notice.

    • message string Required

      Human notification message

      Minimum length is 1, maximum length is 1024.

    • type string Required

      Notification type

      Values are service_powered_off_removal or service_end_of_life.

    • metadata object Required

      Notification type

  • components array[object]

    Service component information objects

    Hide components attributes Show components attributes object

    • component string Required

      Service component name

    • host string Required

      DNS name for connecting to the service component

    • port integer(int64) Required

      Port number for connecting to the service component

      Minimum value is 0, maximum value is 65535.

    • route string Required

      Network access route

      Values are dynamic, private, public, or privatelink.

    • 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 string Required

      DNS usage name

      Values are primary or replica.

  • maintenance object

    Automatic maintenance settings

    Hide maintenance attributes Show maintenance attributes object

    • dow string Required

      Day of week for installing updates

      Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

    • time string Required

      Time for installing updates, UTC

      Minimum length is 8, maximum length is 8.

    • updates array[object] Required

      List of updates waiting to be installed

      Hide updates attributes Show updates attributes object

      Update 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(int64)

    TODO UNIT disk space for data storage

    Minimum value is 0.

  • node-memory integer(int64)

    TODO UNIT of memory for each node

    Minimum value is 0.

  • 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 array[object]

    List of ClickHouse users

    Hide users attributes Show users attributes object

    • username string Required

      Username

      Minimum length is 1, maximum length is 64.

    • uuid string(uuid)
    • required boolean