Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Restore Points/ Synchronizing a Restore Point
Updated on 2024-05-11 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.

URI

POST /v3/{project_id}/checkpoints/sync

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

sync

Yes

SyncParam object

Synchronization content
Table 3 SyncParam

Parameter

Mandatory

Type

Description

auto_trigger

Yes

Boolean

Whether automatic triggering is enabled for this synchronization

vault_id

Yes

String

Hybrid cloud vault ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

sync

SyncRespBody object

Synchronization content
Table 5 SyncRespBody

Parameter

Type

Description

operation_log_id

String

Whether automatic triggering is enabled

vault_id

String

Hybrid cloud 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