Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Backups/ Synchronizing a Backup
Updated on 2025-10-24 GMT+08:00
View PDF

Synchronizing a Backup

Function

This API is used to synchronize on-premises VMware backups.

URI

POST /v3/{project_id}/backups/sync

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

sync

Yes

Array of BackupSync objects

List of backups to be synchronized. The value ranges from 1 to 50.
Table 4 BackupSync

Parameter

Mandatory

Type

Description

backup_id

Yes

String

Backup ID. Default value: N/A

backup_name

Yes

String

Backup name. The value can contain a maximum of 64 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-). Default value: N/A

bucket_name

Yes

String

Bucket name. The value can contain a maximum of 255 characters. Default value: N/A

image_path

Yes

String

Backup's path on the storage unit. Default value: N/A

resource_id

Yes

String

ID of the resource to be backed up. The resource must have been associated with the vault and can be backed up. Default value: N/A

resource_name

Yes

String

Backup object name. Default value: N/A

resource_type

Yes

String

Type of the resource to be backed up. The default value is OS::Native::Server. Default value: N/A The value can be:

  • OS::Native::Server: local server

  • OS::VMware::Server: VMware server

created_at

Yes

Integer

Backup timestamp, for example, 1548898428. Default value: N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

sync

Array of BackupSyncRespBody objects

Return information of the API for importing backups
Table 6 BackupSyncRespBody

Parameter

Type

Description

backup_id

String

Backup ID.

operation_log_id

String

Synchronization task ID. Range: N/A

Example Requests

Synchronizing an on-premises VMware backup

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/sync

{
  "sync" : [ {
    "backup_id" : "1f9e6b47-7655-4a19-b563-21b4ef023025",
    "resource_id" : "96f7512d-239d-3f31-80cf-d1ce041df9a6",
    "resource_name" : "resource_name",
    "resource_type" : "OS::Nova::Server",
    "bucket_name" : "1555230361623e4ce4700dab84b7d8169a5eaec05227d",
    "image_path" : "6abec15e-7baf-4d79-b5a9-6b98a2da7020/cfe0295c-5939-4b31-96cd-161b4725e7ad/cfe0295c-5939-4b31-96cd-161b4725e7ad",
    "created_at" : 1553587260,
    "backup_name" : "backup_name"
  } ]
}

Example Responses

Status code: 200

OK

{
  "sync" : [ {
    "backup_id" : "1f9e6b47-7655-4a19-b563-21b4ef023025",
    "operation_log_id" : "154f0a9d-ba53-4e91-a3e2-a918710a9e0d"
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Backups