Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Restore Points/ Synchronizing a Restore Point
Updated on 2025-11-03 GMT+08:00
View PDF
Share

Synchronizing a Restore Point

Function

This API is used to synchronize backups for a vault.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v3/{project_id}/checkpoints/sync

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Default value: N/A

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

sync

Yes

SyncParam object

Content of the checkpoint to be synchronized.
Table 3 SyncParam

Parameter

Mandatory

Type

Description

auto_trigger

Yes

Boolean

Whether the task is automatically triggered. Default value: false.

  • true: The task is automatically triggered.

  • false: The task is not automatically triggered.

vault_id

Yes

String

ID of the hybrid cloud vault. Default value: N/A

For details about how to obtain the vault ID, see Obtaining a Vault ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

sync

SyncRespBody object

Content of the checkpoint to be synchronized.
Table 5 SyncRespBody

Parameter

Type

Description

operation_log_id

String

ID of the synchronization task.

For details, see Querying Task Details.

vault_id

String

ID of the hybrid cloud vault.

For details about how to obtain the vault ID, see Obtaining a Vault ID.

Example Requests

Manually synchronizing backups

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

{
  "sync" : {
    "vault_id" : "8d3a8b28-a697-41e2-8d5d-903669f8a02d",
    "auto_trigger" : false
  }
}

Example Responses

Status code: 200

OK

{
  "sync" : {
    "operation_log_id" : "60baed87-7e30-4bd8-b71c-89e4a4f7547d",
    "vault_id" : "8d3a8b28-a697-41e2-8d5d-903669f8a02d"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Restore Points