Synchronizing Repositories

You can synchronize cache between object storage and extended backup repository with the specified ID.

Request

POST https://<hostname>:4443/v6/BackupRepositories/{repositoryId}/Sync

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

repositoryId

string

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property

Type

Description

id

string

Specifies the identification number of the synchronization session.

repositoryId

string

Specifies the identification number of the backup repository being synchronized.

state

string

Specifies the synchronization state.

progressPercent

string

Specifies the synchronization progress in percents.

error

string

Specifies an error when synchronizing the backup repository.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

This example shows how to synchronize a backup repository with the ID 08d2e6c0-89d5-49bf-8a9b-873f5064d9be.

Request:

POST https://abc.tech.local:4443/v6/BackupRepositories/08d2e6c0-89d5-49bf-8a9b-873f5064d9be/Sync

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "id": "c6d1fc1b-1aef-411f-9a7f-de35e546c615",

  "repositoryId": "08d2e6c0-89d5-49bf-8a9b-873f5064d9be",

  "state": "Synchronizing",

  "progressPercent": 0,

  "_links":    {

     "self": {"href": "/v6/RepositorySynchronizeSessions/c6d1fc1b-1aef-411f-9a7f-de35e546c615"},

     "repository": {"href": "/v6/backuprepositories/08d2e6c0-89d5-49bf-8a9b-873f5064d9be"}

  }

}