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", or "ThirdPartyConsumer") Documents, ThridpartyDocuments, CustomCloud, Local, DataStore, ThirdPartyConsumer Documents
storageParams
sent in body
Storage parameters Dictionary(key:string, value:string)
collection
[{"Key": "some text","Value": "some text"}]
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": "some text",
      "Value": "some text"
    }
  ],
  "backupMail": true
}
Returns

Backup progress

Example Response

application/json

{
  "status": 0,
  "response": {
    "IsCompleted": false,
    "Progress": 44,
    "Error": null,
    "Link": "Link"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <IsCompleted>False</IsCompleted>
    <Progress>44</Progress>
    <Error />
    <Link>Link</Link>
  </response>
</result>