Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Get service backup bucket

Beta
GET/v1/organizations/{organizationId}/services/{serviceId}/backupBucket
API playground

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns the service backup bucket.

Permission

The API key must have the control-plane:service:view-backups permission.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the service.

    format: uuid
  • serviceIdstringrequired

    ID of the service.

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • 3 variants

    One of the following:

    • 5 properties
      • idoptionalstring

        Unique backup bucket ID

        format: uuid
      • bucketProvideroptionalAWS

        Bucket provider

      • bucketPathoptionalstring

        Bucket path

      • iamRoleArnoptionalstring

        AWS Role ARN

      • iamRoleSessionNameoptionalstring

        AWS Role session name

    • 4 properties
      • idoptionalstring

        Unique backup bucket ID

        format: uuid
      • bucketProvideroptionalGCP

        Bucket provider

      • bucketPathoptionalstring

        Bucket path

      • accessKeyIdoptionalstring

        Access Key ID (HMAC key)

    • 3 properties
      • idoptionalstring

        Unique backup bucket ID.

        format: uuid
      • bucketProvideroptionalAZURE

        Bucket provider

      • containerNameoptionalstring

        Container Name

Navigation