Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get service backup bucket

Beta
View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/services/{serviceId}/backupBucket

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

Returns the service backup bucket.

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
  • resultoptionalAwsBackupBucketorGcpBackupBucketorAzureBackupBucket
    3 variants

    One of the following:

    • AwsBackupBucket
      View AwsBackupBucket schema →
      5 properties
      • idoptionalstring

        Unique backup bucket ID

        format: uuid
      • bucketProvideroptionalAWS

        Bucket provider

      • bucketPathoptionalstring

        Bucket path

      • iamRoleArnoptionalstring

        AWS Role ARN

      • iamRoleSessionNameoptionalstring

        AWS Role session name

    • GcpBackupBucket
      View GcpBackupBucket schema →
      4 properties
      • idoptionalstring

        Unique backup bucket ID

        format: uuid
      • bucketProvideroptionalGCP

        Bucket provider

      • bucketPathoptionalstring

        Bucket path

      • accessKeyIdoptionalstring

        Access Key ID (HMAC key)

    • AzureBackupBucket
      View AzureBackupBucket schema →
      3 properties
      • idoptionalstring

        Unique backup bucket ID.

        format: uuid
      • bucketProvideroptionalAZURE

        Bucket provider

      • containerNameoptionalstring

        Container Name

Navigation