Instaclustr ClickHouse Configurations API

openapi: 3.2.0
info:
  title: Instaclustr ClickHouse Configurations API
  version: Current
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged ClickHouse Configurations across 2 of this provider''s published API definitions: instaclustr-current-openapi.json, instaclustr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instaclustr.com
  description: Instaclustr API
security:
- Basic Authentication: []
tags:
- name: ClickHouse Configurations
  description: Operations related to ClickHouse configuration properties.
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/resources/applications/clickhouse/configurations/v2:
    x-terraform-resource-name: clickhouse_configuration_v2
    post:
      tags:
      - ClickHouse Configurations
      summary: Create configuration
      description: Create ClickHouse configuration with a collection of overrides.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClickHouseConfigurationV2'
        required: true
      responses:
        '202':
          description: ClickHouse configuration created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClickHouseConfigurationV2'
              example:
                clusterId: b997a00d-5bd4-4774-9bd7-5c0ad6189246
                configurationOverrides:
                - name: max_threads
                  value: '16'
                - name: log_queries
                  value: '1'
                id: cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246
        '404':
          description: ClickHouse cluster not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2ResourcesApplicationsClickhouseConfigurationsV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/applications/clickhouse/configurations/v2/{id}:
    parameters:
    - name: id
      in: path
      description: 'ID of the cluster''s configuration. This should be of the form: ''cfg-<cluster uuid>''.'
      required: true
      style: simple
      explode: false
      schema:
        type: string
    get:
      tags:
      - ClickHouse Configurations
      summary: Retrieve all configuration overrides applied to the cluster
      description: Retrieve all configuration overrides applied to the cluster.
      responses:
        '200':
          description: ClickHouse configuration overrides successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClickHouseConfigurationV2'
              example:
                clusterId: b997a00d-5bd4-4774-9bd7-5c0ad6189246
                configurationOverrides:
                - name: max_threads
                  value: '16'
                - name: log_queries
                  value: '1'
                id: cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246
        '404':
          description: ClickHouse configuration not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-terraform-resource-timeout: 99999m
      operationId: getClusterManagementV2ResourcesApplicationsClickhouseConfigurationsV2ById
      x-operation-id-source: derived
    put:
      tags:
      - ClickHouse Configurations
      summary: Update ClickHouse configuration overrides
      description: Update ClickHouse configuration overrides.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClickHouseConfigurationV2'
        required: true
      responses:
        '202':
          description: ClickHouse configuration overrides successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClickHouseConfigurationV2'
              example:
                clusterId: b997a00d-5bd4-4774-9bd7-5c0ad6189246
                configurationOverrides:
                - name: max_threads
                  value: '16'
                - name: log_queries
                  value: '1'
                id: cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246
        '404':
          description: ClickHouse configuration not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-codegen-request-body-name: body
      x-terraform-resource-timeout: 99999m
      operationId: putClusterManagementV2ResourcesApplicationsClickhouseConfigurationsV2ById
      x-operation-id-source: derived
    delete:
      tags:
      - ClickHouse Configurations
      summary: Reset ClickHouse configuration
      description: Restore all configuration properties to their corresponding defaults.
      responses:
        '204':
          description: ClickHouse configuration overrides deleted for the cluster.
          content: {}
        '404':
          description: ClickHouse configuration not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-terraform-resource-timeout: 99999m
      operationId: deleteClusterManagementV2ResourcesApplicationsClickhouseConfigurationsV2ById
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    ErrorListResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseV2'
      description: ''
    ErrorResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        name:
          type: string
        message:
          type: string
      description: ''
    ClickHouseConfigurationV2:
      type: object
      properties:
        configurationOverrides:
          minItems: 1
          type: array
          description: List of configuration overrides
          items:
            required:
            - name
            type: object
            properties:
              name:
                type: string
                description: Name of the configuration property.
                enum:
                - max_threads
                - max_insert_threads
                - use_skip_indexes
                - insert_quorum
                - insert_quorum_timeout
                - insert_quorum_parallel
                - distributed_ddl_task_timeout
                - log_queries
                - max_execution_time
                - max_bytes_before_external_group_by
                - max_bytes_before_external_sort
                - optimize_on_insert
                - max_partition_size_to_drop
                - allow_experimental_json_type
                - http_connection_timeout
                - http_send_timeout
                - http_receive_timeout
                - keep_alive_timeout
                - tcp_keep_alive_timeout
              value:
                type: string
                description: Override value for the configuration property.
          x-terraform-field-name: override
          x-terraform-ignore-order: true
        clusterId:
          type: string
          description: ID of the ClickHouse cluster
          example: b997a00d-5bd4-4774-9bd7-5c0ad6189246
          x-terraform-force-new: true
        id:
          type: string
          description: 'ID of the cluster''s configuration. This should be of the form: ''cfg-<cluster uuid>''.'
          readOnly: true
          example: cfg-b997a00d-5bd4-4774-9bd7-5c0ad6189246
      description: ClickHouse configuration overrides
      example:
        clusterId: b997a00d-5bd4-4774-9bd7-5c0ad6189246
        configurationOverrides:
        - name: max_threads
          value: '16'
        - name: log_queries
          value: '1'
  securitySchemes:
    Basic_Authentication:
      type: http
      description: Most requests to the API must use Basic Authentication and contain a valid username and appropriate API key for the endpoint.<br><br>API keys can be retrieved any time from the <a href='https://console2.instaclustr.com/' target='_blank'>console</a>. To find the API key relevant to the endpoint, refer to the Authentication & Rate Limit section for the endpoint or the group of the endpoint.
      scheme: basic
    No_Authentication:
      type: http
      description: Certain endpoints are publicly available and does not need any authentication to access.
      scheme: none
x-refined-from:
- instaclustr-current-openapi.json
- instaclustr-openapi.yml
x-tagGroups:
- name: Cluster Management V2
  tags:
  - Cluster Management V2 - Trait
  - Account Cluster List V2
  - AWS Encryption Key V2
  - AWS Endpoint DNS Names V2
  - AWS Endpoint Service Names V2
  - AWS Endpoint Service Principals V2
  - AWS FSx ONTAP File Systems
  - AWS FSx ONTAP Filesystem Credentials V2
  - AWS Prefix List Firewall Rule V1
  - AWS Prefix List Firewall Rules V1
  - AWS Security Group Firewall Rule V2
  - AWS Security Group Firewall Rules V2
  - AWS VPC Peer V2
  - Apache Cassandra Provisioning V2
  - Apache Kafka ACL V2
  - Apache Kafka ACL V3
  - Apache Kafka Connect Mirror V2
  - Apache Kafka Connect Provisioning V2
  - Apache Kafka Provisioning V2
  - Apache Kafka Provisioning V3
  - Apache Kafka Rest Proxy User
  - Apache Kafka Schema Registry User
  - Apache Kafka Tiered Storage
  - Apache Kafka Topic V2
  - Apache Kafka Topic V3
  - Apache Kafka User
  - Apache Zookeeper Provisioning V2
  - Azure Private Link Service Subscriptions
  - Azure Vnet Peer V2
  - BYOC AWS CloudFormation
  - BYOC AWS Provider Account Setup V1
  - Cadence Domain Rate Limits V2
  - Cadence Global Domain Rate Limits V2
  - Cadence Provisioning V2
  - ClickHouse Configurations
  - ClickHouse Integrations
  - ClickHouse Provisioning
  - Cloud Provider Details V2
  - Cluster Exclusion Window V2
  - Cluster Maintenance Events V2
  - Cluster Network Firewall Rule V2
  - Cluster Network Firewall Rules V2
  - Cluster Non Recurring Exclusion Window V2
  - Cluster Settings V2
  - Cluster Suspend Resume V2
  - Custom Tags V2
  - GCP PSC Service Attachments Accept List V2
  - GCP VPC Peer V2
  - Horizontal Scaling Operations
  - Karapace Rest Proxy User
  - Karapace Schema Registry User
  - MCP Gateway Backend V1
  - MCP Gateway Persona Access Control V1
  - MCP Gateway Provisioning V1
  - MCP Gateway Tool V1
  - MCP Gateway Virtual Server V1
  - Management Units Usage
  - OpenSearch Egress Rules V2
  - OpenSearch External S3 Bucket V2
  - OpenSearch Provisioning V2
  - PostgreSQL Configuration V2
  - PostgreSQL Operations
  - PostgreSQL Provisioning V2
  - Private Link Private Service Connect Endpoint Addresses V2
  - Redis Provisioning V2
  - Redis User V2
  - Resize Operations V2
  - Terraform Import V2
  - User Actions V3
  - Valkey Provisioning V2
  - Valkey User V2
- name: Monitoring
  tags:
  - Monitoring - Trait
  - Monitoring API
  - Monitoring API - Cluster
  - Monitoring API - Data Centre
  - Monitoring API - Node
- name: User Management
  tags:
  - User Management and SCIM 2.0 API - Trait
  - Service User Management API
  - User Management and SCIM 2.0 API
- name: Other
  tags:
  - Organization Management API
  - Pricing information - Node sizes