Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get backup details

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

Returns a single backup info.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the backup.

    format: uuid
  • serviceIdstringrequired

    ID of the service the backup was created from.

    format: uuid
  • backupIdstringrequired

    ID of the requested backup.

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    10 properties
    • idoptionalstring

      Unique backup ID.

      format: uuid
    • statusoptionaldoneorerrororin_progress

      Status of the backup: 'done', 'error', 'in_progress'.

    • serviceIdoptionalstring

      Name

    • startedAtoptionalstring

      Backup start timestamp. ISO-8601.

      format: date-time
    • finishedAtoptionalstring

      Backup finish timestamp. ISO-8601. Available only for finished backups

      format: date-time
    • sizeInBytesoptionalnumber

      Size of the backup in bytes.

    • durationInSecondsoptionalnumber

      Time in seconds it took to perform the backup. If the status still in_progress, this is the time in seconds since the backup started until now.

    • typeoptionalfullorincremental

      Backup type ("full" or "incremental").

    • backupNameoptionalstring

      Backup name on the external backup bucket.

    • bucketoptionalAwsBackupBucketPropertiesorGcpBackupBucketPropertiesorAzureBackupBucketProperties

      Backup bucket where the backup is stored.

      3 variants

      One of the following:

Navigation