[BETA] Create a DBaaS ClickHouse service

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://openapi-v2.exoscale.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Exoscale APIv2 MCP server": {
    "url": "https://openapi-v2.exoscale.com/mcp"
  }
}
Close
POST /dbaas-clickhouse/{name}

Path parameters

  • name string Required

    Minimum length is 0, maximum length is 63.

application/json

Body Required

  • maintenance object

    Automatic maintenance settings

    Hide maintenance attributes Show maintenance attributes object
    • dow string Required

      Day of week for installing updates

      Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

    • time string Required

      Time for installing updates, UTC

      Minimum length is 8, maximum length is 8.

  • plan string Required

    Subscription plan

    Minimum length is 1, maximum length is 128.

  • termination-protection boolean

    Service is protected against termination and powering off

  • version string

    ClickHouse major version

    Minimum length is 1.

  • ip-filter array[string]

    Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

  • clickhouse-settings object

    ClickHouse-specific settings

    Hide clickhouse-settings attribute Show clickhouse-settings attribute object
    • server_settings object

      ClickHouse server settings, which can be found in the system.server_settings table.

      Additional properties are NOT allowed.

      Hide server_settings attribute Show server_settings attribute object
      • vector_similarity_index_cache_size number

        Fraction of total server memory allocated to the vector similarity index cache. 0 disables the cache. Default is 0.07 (7% of server memory). Only effective on ClickHouse 25.8+.

        Minimum value is 0, maximum value is 0.5. Default value is 0.07.

  • fork-from-service string

    Service to fork from

    Minimum length is 0, maximum length is 63.

  • recovery-backup-name string

    Name of a backup to recover from for services that support backup names

    Minimum length is 1.

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • reference object

      Related resource reference

      Hide reference attributes Show reference attributes object
      • id string(uuid)

        Reference ID

      • link string

        Link to the referenced resource

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.
POST /dbaas-clickhouse/{name} 
curl \
 --request POST 'https://api-ch-gva-2.exoscale.com/v2/dbaas-clickhouse/{name}' \
 --header "Content-Type: application/json" \
 --data '{"maintenance":{"dow":"saturday","time":"string"},"plan":"string","termination-protection":true,"version":"string","ip-filter":["string"],"clickhouse-settings":{"server_settings":{"vector_similarity_index_cache_size":0.07}},"fork-from-service":"string","recovery-backup-name":"string"}'
Request examples 
{
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "version": "string",
  "ip-filter": [
    "string"
  ],
  "clickhouse-settings": {
    "server_settings": {
      "vector_similarity_index_cache_size": 0.07
    }
  },
  "fork-from-service": "string",
  "recovery-backup-name": "string"
}
Response examples (200) 
{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}