Get Started
Usage API
More information

POST api/2.0/portal/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 Documents, ThridpartyDocuments, CustomCloud, Local, DataStore, ThirdPartyConsumer
storageParams
sent in body
Storage parameters Collection of ASC.Api.Collections.ItemKeyValuePair`2[System.String,System.String]s
collection
backupMail
sent in body
Specifies if the mails will be included into the backup or not Bool value true
Example
POST api/2.0/portal/startbackup
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "storageType": "documents",
  "storageParams": [
    {
      "Key": null,
      "Value": null
    }
  ],
  "backupMail": true
}
Returns

Backup progress