TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

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 string some text
StorageParams
sent in body
Storage parameters Collection of ASC.Api.Collections.ItemKeyValuePair{System.Objecs
collection
Dump
sent in body
Specifies if a dump will be created or not Bool value true
Example
POST api/2.0/backup/startbackup
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "StorageType": "Documents",
  "Dump": true
}
Returns

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