Get ClickHouse settings schema

GET/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/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.

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service.

format: uuid

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
1 properties
- settingsoptionalarray ofobject
  List of all configurable ClickHouse settings with their types, descriptions, and constraints.
  
  7 properties
  nameoptionalstring
  Name of the setting.
  
  Example: "compatibility"
  typeoptionalstring
  Data type of the setting value.
  
  Example: "string"
  descriptionoptionalstring
  Description of the setting.
  
  Example: "ClickHouse version compatibility setting."
  enumoptionalarray ofinteger
  List of allowed values, if the setting is an enum.
  
  Example: [0,1]
  warningoptionalstring
  Warning message about potential disruptive effects of changing this setting.
  
  Example: "Changing this setting without comprehensive testing can cause instability."
  deprecationNoticeoptionalstring
  Deprecation notice, if applicable.
  
  Example: "This setting may become obsolete with Cloud v2 stateless workers."
  exampleoptionalstring
  Example value for the setting.
  
  Example: "24.8"

Get ClickHouse settings schema

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickhouseSettings/schema \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickhouseSettings/schema';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickhouseSettings/schema"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "settings": [
      {
        "name": "compatibility",
        "type": "string",
        "description": "ClickHouse version compatibility setting.",
        "enum": [
          0,
          1
        ],
        "warning": "Changing this setting without comprehensive testing can cause instability.",
        "deprecationNotice": "This setting may become obsolete with Cloud v2 stateless workers.",
        "example": "24.8"
      }
    ]
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}