ClickHouse

ClickHouse Backup API

The Backup API from ClickHouse — 4 operation(s) for backup.

GitHub OpenAPI
Business capability
Disaster Recovery & Resilience BC-4220.60

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/organizations/{organizationId}/services/{serviceId}/backups List a service's backups · List of service backups #
Ask an LLM
“What backups exist for my ClickHouse service, newest first?”
“When was the most recent backup of this service taken?”
Tell an agent
List all backups for service {service} in org {org}.
Show the latest backups taken of service {service} in organization {org}.
GET /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId} Get details of one backup · Get backup details #
Ask an LLM
“What are the details of one particular backup?”
“Did a specific backup of my service finish successfully?”
Tell an agent
Show backup {backupId} of service {service} in org {org}.
Check whether backup {backupId} for service {service} in organization {org} completed.
GET /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration Get a service's backup schedule and retention · Get service backup configuration #
Ask an LLM
“How often is my service backed up and how long are backups kept?”
“What start time is configured for this service's backups?”
Tell an agent
Show the backup configuration for service {service} in org {org}.
Tell me the backup period and retention settings on service {service} in organization {org}.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration Change a service's backup schedule and retention · Update service backup configuration #
Ask an LLM
“Can I take backups every 12 hours and keep them longer?”
“How do I reset the backup schedule back to its defaults?”
Tell an agent
Back up service {service} in org {org} every {backupPeriodInHours} hours.
Keep backups of service {service} in organization {org} for {backupRetentionPeriodInHours} hours, starting at {backupStartTime}.
GET /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Get a service's custom backup bucket · Get service backup bucket #
Ask an LLM
“Which external bucket are my service's backups written to?”
“Is a bring-your-own backup bucket configured for this service?”
Tell an agent
Show the backup bucket configured for service {service} in org {org}.
Check whether service {service} in organization {org} sends backups to its own bucket.
POST /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Set up a custom backup bucket for a service · Create service backup bucket #
Ask an LLM
“How do I send my service's backups to a bucket in my own cloud account?”
“What role does my API key need to add a backup bucket?”
Tell an agent
Create a backup bucket for service {service} in org {org}.
Configure service {service} in organization {org} to write backups to my own bucket.
PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Update a service's custom backup bucket · Update service backup bucket #
Ask an LLM
“How do I rotate the credentials on my existing backup bucket?”
“Do I have to resend the bucket secrets every time I change the backup bucket?”
Tell an agent
Update the existing backup bucket settings for service {service} in org {org}.
Rotate the secrets on the backup bucket already attached to service {service} in organization {org}.
DELETE /v1/organizations/{organizationId}/services/{serviceId}/backupBucket Remove a service's custom backup bucket · Delete service backup bucket #
Ask an LLM
“How do I stop using my own bucket for a service's backups?”
“Can I detach the external backup bucket from a service?”
Tell an agent destructive · confirm first
Delete the backup bucket configured on service {service} in org {org}.
Remove the custom backup bucket from service {service} in organization {org}.

Documentation

📖
Documentation
https://clickhouse.com/docs/cloud/manage/api/api-overview
📖
APIReference
https://clickhouse.com/docs/products/cloud/api-reference/organization/get-list-of-available-organizations

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-backup-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/mcp/clickhouse-tool-crosswalk.yml
🔗
Swagger
https://clickhouse.com/docs/cloud/manage/api/swagger

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clickhouse:clickhouse-backup-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clickhouse-backup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI spec for ClickHouse Cloud Backup API
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1107336
    email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:
- name: Backup
paths:
  /v1/organizations/{organizationId}/services/{serviceId}/backups:
    get:
      summary: List of service backups
      description: Returns a list of all backups for the service. The most recent backups comes first in the list.
      operationId: backupGetList
      parameters:
      - in: path
        name: organizationId
        description: ID of the organization that owns the backup.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: serviceId
        description: ID of the service the backup was created from.
        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:
                    type: array
                    items:
                      $ref: '#/components/schemas/Backup'
        '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
      tags:
      - Backup
  /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}:
    get:
      summary: Get backup details
      description: Returns a single backup info.
      operationId: backupGet
      parameters:
      - in: path
        name: organizationId
        description: ID of the organization that owns the backup.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: serviceId
        description: ID of the service the backup was created from.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: backupId
        description: ID of the requested backup.
        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/Backup'
        '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
      tags:
      - Backup
  /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration:
    get:
      summary: Get service backup configuration
      description: Returns the service backup configuration.
      operationId: backupConfigurationGet
      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/BackupConfiguration'
        '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
      tags:
      - Backup
    patch:
      summary: Update service backup configuration
      description: Updates service backup configuration. Requires ADMIN auth key role. Setting the properties with null value, will reset the properties to theirs default values.
      operationId: backupConfigurationUpdate
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupConfigurationPatchRequest'
      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/BackupConfiguration'
        '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
      tags:
      - Backup
  /v1/organizations/{organizationId}/services/{serviceId}/backupBucket:
    get:
      summary: Get service backup bucket
      description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.


        Returns the service backup bucket.'
      operationId: backupBucketGet
      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/BackupBucket'
        '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
      tags:
      - Backup
      x-badges:
      - name: Beta
        position: after
    post:
      summary: Create service backup bucket
      description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.


        Create service backup bucket. Requires ADMIN auth key role.'
      operationId: backupBucketCreate
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: serviceId
        description: ID of the requested service.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupBucketPostRequest'
      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/BackupBucket'
        '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
      tags:
      - Backup
      x-badges:
      - name: Beta
        position: after
    patch:
      summary: Update service backup bucket
      description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.


        Update service backup bucket. Requires ADMIN auth key role. The secrets of the specified bucket provider are always required'
      operationId: backupBucketUpdate
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: serviceId
        description: ID of the requested service.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupBucketPatchRequest'
      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/BackupBucket'
        '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
      tags:
      - Backup
      x-badges:
      - name: Beta
        position: after
    delete:
      summary: Delete service backup bucket
      description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.


        Delete service backup bucket. Requires ADMIN auth key role.'
      operationId: backupBucketDelete
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: serviceId
        description: ID of the requested 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
        '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
      tags:
      - Backup
      x-badges:
      - name: Beta
        position: after
components:
  schemas:
    GcpBackupBucket:
      properties:
        id:
          description: Unique backup bucket ID
          type: string
          format: uuid
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - GCP
        bucketPath:
          description: Bucket path
          type: string
        accessKeyId:
          description: Access Key ID (HMAC key)
          type: string
    GcpBackupBucketPostRequestV1:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - GCP
        bucketPath:
          description: Bucket path
          type: string
        accessKeyId:
          description: Access Key ID (HMAC key)
          type: string
        secretAccessKey:
          description: Secret Access Key (HMAC secret key)
          type: string
    GcpBackupBucketPatchRequestV1:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - GCP
        bucketPath:
          description: Bucket path
          type: string
        accessKeyId:
          description: Access Key ID (HMAC key)
          type: string
        secretAccessKey:
          description: Secret Access Key (HMAC secret key)
          type: string
    AzureBackupBucketPostRequestV1:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AZURE
        containerName:
          description: Container Name
          type: string
        connectionString:
          description: Connection String
          type: string
    BackupBucket:
      oneOf:
      - $ref: '#/components/schemas/AwsBackupBucket'
      - $ref: '#/components/schemas/GcpBackupBucket'
      - $ref: '#/components/schemas/AzureBackupBucket'
    AzureBackupBucket:
      properties:
        id:
          description: Unique backup bucket ID.
          type: string
          format: uuid
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AZURE
        containerName:
          description: Container Name
          type: string
    BackupBucketPostRequest:
      oneOf:
      - $ref: '#/components/schemas/AwsBackupBucketPostRequestV1'
      - $ref: '#/components/schemas/GcpBackupBucketPostRequestV1'
      - $ref: '#/components/schemas/AzureBackupBucketPostRequestV1'
    BackupBucketPatchRequest:
      oneOf:
      - $ref: '#/components/schemas/AwsBackupBucketPatchRequestV1'
      - $ref: '#/components/schemas/GcpBackupBucketPatchRequestV1'
      - $ref: '#/components/schemas/AzureBackupBucketPatchRequestV1'
    Backup:
      properties:
        id:
          description: Unique backup ID.
          type: string
          format: uuid
        status:
          description: 'Status of the backup: ''done'', ''error'', ''in_progress''.'
          type: string
          enum:
          - done
          - error
          - in_progress
        serviceId:
          description: 'Name '
          type: string
        startedAt:
          description: Backup start timestamp. ISO-8601.
          type: string
          format: date-time
        finishedAt:
          description: Backup finish timestamp. ISO-8601. Available only for finished backups
          type: string
          format: date-time
        sizeInBytes:
          description: Size of the backup in bytes.
          type: number
        durationInSeconds:
          description: Time in seconds it took to perform the backup. If the status still in_progress, this is the time in seconds since the backup started until now.
          type: number
        type:
          description: Backup type ("full" or "incremental").
          type: string
          enum:
          - full
          - incremental
        backupName:
          description: Backup name on the external backup bucket.
          type: string
        bucket:
          description: Backup bucket where the backup is stored.
          oneOf:
          - $ref: '#/components/schemas/AwsBackupBucketProperties'
          - $ref: '#/components/schemas/GcpBackupBucketProperties'
          - $ref: '#/components/schemas/AzureBackupBucketProperties'
    AzureBackupBucketPatchRequestV1:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AZURE
        containerName:
          description: Container Name
          type: string
        connectionString:
          description: Connection String
          type: string
    BackupConfiguration:
      properties:
        backupPeriodInHours:
          description: The interval in hours between each backup.
          type: number
        backupRetentionPeriodInHours:
          description: The minimum duration in hours for which the backups are available. Must be a whole number of days between 24 (1 day) and 1080 (45 days) — i.e. a multiple of 24.
          type: number
        backupStartTime:
          description: The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.
          type: string
    AwsBackupBucketPostRequestV1:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AWS
        bucketPath:
          description: Bucket path
          type: string
        iamRoleArn:
          description: AWS Role ARN
          type: string
        iamRoleSessionName:
          description: AWS Role session name
          type: string
    BackupConfigurationPatchRequest:
      properties:
        backupPeriodInHours:
          description: The interval in hours between each backup.
          type: number
        backupRetentionPeriodInHours:
          description: The minimum duration in hours for which the backups are available. Must be a whole number of days between 24 (1 day) and 1080 (45 days) — i.e. a multiple of 24.
          type: number
        backupStartTime:
          description: The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.
          type: string
    AwsBackupBucketPatchRequestV1:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AWS
        bucketPath:
          description: Bucket path
          type: string
        iamRoleArn:
          description: AWS Role ARN
          type: string
        iamRoleSessionName:
          description: AWS IAM Role session name
          type:
          - string
          - 'null'
    AwsBackupBucketProperties:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AWS
        bucketPath:
          description: Bucket path
          type: string
        iamRoleArn:
          description: AWS IAM Role
          type: string
        iamRoleSessionName:
          description: AWS IAM Role
          type: string
    GcpBackupBucketProperties:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - GCP
        bucketPath:
          description: Bucket path
          type: string
        accessKeyId:
          description: Access Key ID (HMAC key)
          type: string
    AwsBackupBucket:
      properties:
        id:
          description: Unique backup bucket ID
          type: string
          format: uuid
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AWS
        bucketPath:
          description: Bucket path
          type: string
        iamRoleArn:
          description: AWS Role ARN
          type: string
        iamRoleSessionName:
          description: AWS  Role session name
          type: string
    AzureBackupBucketProperties:
      properties:
        bucketProvider:
          description: Bucket provider
          type: string
          enum:
          - AZURE
        containerName:
          description: Container Name
          type: string
  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'
x-tagGroups:
- name: Organization
  tags:
  - Organization
  - Billing
  - User management
  - Role Management
  - UDF
- name: Service
  tags:
  - Service
  - Backup
- name: API keys
  tags:
  - API keys
- name: Prometheus
  tags:
  - Prometheus
- name: ClickPipes
  tags:
  - ClickPipes
- name: ClickStack
  tags:
  - ClickStack
- name: Postgres
  tags:
  - Postgres