Get Started
Portal api methods
Help

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

Description

Create the backup schedule 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 parameters Collection of ASC.Api.Collections.ItemKeyValuePair`2[System.String,System.String]s
collection
backupsStored
sent in body
Max of the backup's stored copies number 1234
cronParams
sent in body
Cron parameters ASC.Web.Studio.Core.Backup.BackupAjaxHandler+CronParams
backupMail
sent in body
Include mail in the backup 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