Controller: BackupSchedule

API Controller /siteworx/backup/schedule
Required Permissions ["BACKUP"]
Required Options Account Backup
Action Description
create Add a scheduled backup.
listScheduled Lists all the scheduled backups for the current SiteWorx user.

Action: create (Added in version 4.8.0-393)

Add a scheduled backup.

Input Parameters

Name Type Notes Required?
frequency string
Example Values
daily, weekly, monthly
 Yes
type string
Example Values
full, partial, structure
 Yes
location string
Example Values
siteworx, local, ftp, scp
 Yes
email_address string
Example Default Value
user@example.com
 No*
rotate integer
Help Entry
Indicates the maximum number of backups to keep before removing old backups.
Example Default Value
7
 No*
hour integer
Example Values
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
 Yes
* indicates that it's actually required, but probably already has a valid default value

Action: listScheduled (Added in version 4.8.0-393)

Lists all the scheduled backups for the current SiteWorx user.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
  ),
)