ClickHouse Cloud: Clickhouse Service Clickhouse Settings Schema Get

List every configurable ClickHouse setting for a service, with its type, valid values and description.

Tool ID: clickhouse_service_clickhouse_settings_schema_get

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_service_clickhouse_settings_schema_get',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_service_clickhouse_settings_schema_get --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "settings": [
        {
          "name": "Example",
          "type": "example",
          "description": "Example description"
        }
      ]
    }
  }
}

Use deepline describe clickhouse_service_clickhouse_settings_schema_get --json for the latest machine-readable contract.

Input reference

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.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the service. Format: `uuid`.
`payload.serviceId`	`string`	Yes	—	ID of the service. Format: `uuid`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`object`	No	—	—
`result.data.result.settings`	`array`	No	—	List of all configurable ClickHouse settings with their types, descriptions, and constraints.
`result.data.result.settings[].name`	`string`	No	—	Name of the setting.
`result.data.result.settings[].type`	`string`	No	—	Data type of the setting value.
`result.data.result.settings[].description`	`string`	No	—	Description of the setting.
`result.data.result.settings[].enum`	`array`	No	—	List of allowed values, if the setting is an enum.
`result.data.result.settings[].warning`	`string`	No	—	Warning message about potential disruptive effects of changing this setting.
`result.data.result.settings[].deprecationNotice`	`string`	No	—	Deprecation notice, if applicable.
`result.data.result.settings[].example`	`string`	No	—	Example value for the setting.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation