Get Started
Usage API
More information

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

Description

Creates the backup schedule 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
backupsStored
sent in body
Maximum number of backup stored copies number 1234
cronParams
sent in body
Cron parameters ASC.Web.Studio.Core.Backup.BackupAjaxHandler+CronParams
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/createbackupschedule
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "storageType": "documents",
  "storageParams": [
    {
      "Key": null,
      "Value": null
    }
  ],
  "backupsStored": 1234,
  "cronParams": {
    "Period": 0,
    "Hour": 0,
    "Day": 0
  },
  "backupMail": true
}
Returns

This method doesn't return any data.