Backup Repository Synchronization

The /RepositorySynchronizeSessions resource collection represents synchronization sessions when Veeam Backup for Microsoft 365 synchronizes cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.

Get Synchronization Sessions

Returns a list of synchronization sessions.

SecurityBearer

Responses

200

default

Operation failure response.

get/v8/RepositorySynchronizeSessions

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

[{"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"repositoryId": "c3d4e5f6-a7b8-9012-cdef-012345678892",
"state": "None",
"progressPercent": "100",
"_links": {"self": {"href": "/v8/RepositorySynchronizeSessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
},
{"id": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
"repositoryId": "c3d4e5f6-a7b8-9012-cdef-012345678892",
"state": "Synchronizing",
"progressPercent": "45",
"_links": {"self": {"href": "/v8/RepositorySynchronizeSessions/b2c3d4e5-f6a7-8901-bcde-f01234567891"
}
}
},
{"id": "e6f7a8b9-c0d1-2345-fabc-de1234567893",
"repositoryId": "c3d4e5f6-a7b8-9012-cdef-012345678892",
"state": "Failed",
"progressPercent": "0",
"error": "Repository is not available",
"_links": {"self": {"href": "/v8/RepositorySynchronizeSessions/e6f7a8b9-c0d1-2345-fabc-de1234567893"
}
}
}
]

Get Synchronization Session Statistics

Returns statistics for a synchronization session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

Specifies the identification number of the synchronization session. For more information on how to get this parameter, see Get Synchronization Sessions.

Responses

200

default

Operation failure response.

get/v8/RepositorySynchronizeSessions/{sessionId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

{"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"repositoryId": "c3d4e5f6-a7b8-9012-cdef-012345678892",
"state": "None",
"progressPercent": "100",
"_links": {"self": {"href": "/v8/RepositorySynchronizeSessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
}

Stop Synchronization Session

Stops a synchronization session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

Specifies the identification number of the synchronization session. For more information on how to get this parameter, see Get Synchronization Sessions.

Responses

204

No Content

default

Operation failure response.

post/v8/RepositorySynchronizeSessions/{sessionId}/StopSynchronize

Request samples

curl
Python
JavaScript
C#
Go

Response samples

default

application/json

{"message": "string",
"errorCode": "ProxyOffline",
"stackTrace": "string"
}