List of service backups

Returns a list of all backups for the service. The most recent backups comes first in the list.

GET /v1/organizations/{organizationId}/services/{serviceId}/backups

List of service backups

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/backups \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "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.

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object[]

Show child attributes