Service

Update ClickHouse settings

Disclaimer: This beta endpoint is evolving; the API contract may change. <br /><br /> Updates one or more ClickHouse settings for the service. To reset a setting to its platform default, use the DELETE single setting endpoint. Use the schema endpoint to discover which settings are configurable.

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

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service.

Request body

settingsServiceClickhouseSettingsMap required

Nonempty object mapping configurable setting names to their values. Use DELETE to reset a setting.

Example request

{
  "settings": {
    "compatibility": "26.2",
    "max_query_size": 262144
  }
}

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "settings": {
      "compatibility": "26.2",
      "max_query_size": 262144
    },
    "warnings": [
      {
        "name": "compatibility",
        "message": "Changing the compatibility version without comprehensive testing can cause query failures or instability."
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.