Get Started
API backend
API system
More information

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

Description

Starts the backup of the current portal with the parameters specified in the request.

Parameters
Name Description Type Example
StorageType
sent in body
Storage type System.String
StorageParams
sent in body
Storage parameters System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.Object
Example
POST api/2.0/backup/startbackup
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "StorageType": "Documents"
}
Returns

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