Get service backup bucket | ClickHouse Docs

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.

Permission

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

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

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

Get service backup bucket

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/backupBucket \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/backupBucket';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/backupBucket"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "bucketProvider": "AWS",
    "bucketPath": "string",
    "iamRoleArn": "string",
    "iamRoleSessionName": "string"
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}