> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get ClickHouse settings schema

> **Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns the schema of all configurable ClickHouse settings, including types, valid values, descriptions, and warnings.

<span data-endpoint-badge="Beta"><Badge color="blue">Beta</Badge></span>

**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns the schema of all configurable ClickHouse settings, including types, valid values, descriptions, and warnings.


## OpenAPI

````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema
openapi: 3.1.2
info:
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-910487
    email: support@clickhouse.com
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: User management
  - name: Billing
  - name: Role Management
  - name: Service
  - name: Backup
  - name: OpenAPI
  - name: Prometheus
  - name: ClickPipes
  - name: ClickStack
  - name: Postgres
paths:
  /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema:
    get:
      tags:
        - Service
      summary: Get ClickHouse settings schema
      description: >-
        **Disclaimer:** This beta endpoint is evolving; the API contract may
        change. <br /><br /> Returns the schema of all configurable ClickHouse
        settings, including types, valid values, descriptions, and warnings.
      operationId: serviceClickhouseSettingsSchemaGet
      parameters:
        - in: path
          name: organizationId
          description: ID of the organization that owns the service.
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: serviceId
          description: ID of the service.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    $ref: '#/components/schemas/ServiceClickhouseSettingsSchema'
        '400':
          description: >-
            The request cannot be processed due to a client error. Please verify
            your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: >-
            An internal server error has occurred. If this issue persists,
            please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
components:
  schemas:
    ServiceClickhouseSettingsSchema:
      properties:
        settings:
          type: array
          description: >-
            List of all configurable ClickHouse settings with their types,
            descriptions, and constraints.
          items:
            $ref: '#/components/schemas/ServiceClickhouseSettingSchemaEntry'
    ServiceClickhouseSettingSchemaEntry:
      properties:
        name:
          description: Name of the setting.
          type: string
          example: compatibility
        type:
          description: Data type of the setting value.
          type: string
          example: string
        description:
          description: Description of the setting.
          type: string
          example: ClickHouse version compatibility setting.
        enum:
          type: array
          description: List of allowed values, if the setting is an enum.
          items:
            type: integer
          example:
            - 0
            - 1
        warning:
          description: >-
            Warning message about potential disruptive effects of changing this
            setting.
          type: string
          example: >-
            Changing this setting without comprehensive testing can cause
            instability.
        deprecationNotice:
          description: Deprecation notice, if applicable.
          type: string
          example: This setting may become obsolete with Cloud v2 stateless workers.
        example:
          description: Example value for the setting.
          type: string
          example: '24.8'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Use key ID and key secret obtained in ClickHouse Cloud console:
        https://clickhouse.com/docs/cloud/manage/openapi

````