Get Started
Portal api methods
Help

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

Description

Start a backup of the current portal

Parameters
Name Description Type Example
storageType
sent in body
Storage Type Documents, ThridpartyDocuments, CustomCloud, Local, DataStore, ThirdPartyConsumer
storageParams
sent in body
Storage Params Collection of ASC.Api.Collections.ItemKeyValuePair`2[System.String,System.String]s
collection
backupMail
sent in body
Include mail in the backup 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