Skip to main content
GET
/
v1
/
organizations
/
{organizationId}
/
services
/
{serviceId}
/
backups
/
{backupId}
Get backup details
curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "sizeInBytes": 123,
    "durationInSeconds": 123,
    "backupName": "<string>",
    "bucket": {
      "bucketPath": "<string>",
      "iamRoleArn": "<string>",
      "iamRoleSessionName": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationId
string<uuid>
required

ID of the organization that owns the backup.

​
serviceId
string<uuid>
required

ID of the service the backup was created from.

​
backupId
string<uuid>
required

ID of the requested backup.

Response

Successful response

​
status
number

HTTP status code.

Example:

200

​
requestId
string<uuid>

Unique id assigned to every request. UUIDv4

​
result
object