跳到主要内容

CreateBackupScheduleRequestDto

The request parameters for setting the backup schedule.

NameTypeDescriptionNotes
storageTypeBackupStorageTypeThe storage the scheduled archives are written to. It defaults to Documents, and it decides which keys storageParams has to carry.[optional] [enum: 0, 1, 2, 3, 4, 5]
storageParamsListThe settings of the chosen storage, as an array of key and value pairs. Documents and ThridpartyDocuments need folderId, Local needs filePath, ThirdPartyConsumer needs module plus the settings of that consumer, and DataStore needs none.[optional] [example: [{key=folderId, value=1234}]] [nullable]
backupsStoredInteger (int32)The number of scheduled copies to keep, from 1 to 30. It defaults to 1, and only the copies this schedule creates are counted and removed - archives started by hand are left alone.[optional] [example: 5] [nullable]
cronParamsBackupCronRequestWhen the backup runs. It is required: a request without it fails rather than falling back to a default.[optional]
dumpBooleanSchedules a backup of the whole server rather than of this one portal. It requires the space access permission and works on a standalone installation only.[optional] [example: false]