POST api/2.0/portal/createbackupschedule
Creates the backup schedule for the current portal with the parameters specified in the request.
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"}]
|
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
|
POST api/2.0/portal/createbackupschedule
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"storageType": "Documents",
"storageParams": [
{
"Key": "some text",
"Value": "some text"
}
],
"backupsStored": 1234,
"cronParams": {
"Period": 0,
"Hour": 0,
"Day": 0
},
"backupMail": true
}
This method doesn't return any data.