Method get

Returns the specified ClickHouse Backup resource.

To get the list of available ClickHouse Backup resources, make a list request.

HTTP request


Path parameters

Parameter Description
backupId Required. ID of the backup to return information about. To get the backup ID, use a listBackups request.


HTTP Code: 200 - OK

  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "sourceClusterId": "string",
  "sourceShardNames": [
  "startedAt": "string"

A ClickHouse Backup resource. See the Developer's Guide for more information.

Field Description
id string

ID of the backup.

folderId string

ID of the folder that the backup belongs to.

createdAt string (date-time)

Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).

String in RFC3339 text format.

sourceClusterId string

ID of the ClickHouse cluster that the backup was created for.

sourceShardNames[] string

Names of the shards included in the backup.

startedAt string (date-time)

Time when the backup operation was started.

String in RFC3339 text format.