Get Started
API backend
API system
More information

POST api/2.0/backup/startrestore This function requires authentication

Description

Starts the data restoring process of the current portal with the parameters specified in the request.

Parameters
Name Description Type Example
BackupId
sent in body
Backup ID System.String
StorageType
sent in body
Storage type System.Object
StorageParams
sent in body
Storage parameters System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Object
Notify
sent in body
Notifies users about portal restoring process or not System.Boolean
Example
POST api/2.0/backup/startrestore
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "BackupId": "some text",
  "StorageType": "Documents",
  "Notify": true
}
Returns

Backup progress: completed or not, progress percentage, error, tenant ID, backup progress item (Backup, Restore, Transfer), link