Part III: SiteWorx API Spec Up Part III: SiteWorx API Spec Chapter 61: Controller: /siteworx/backup/schedule 

60 Controller: /siteworx/backup

Required Permissions "BACKUP"
Required Options Account Backup
Action: create
Added in version 4.7.0-339
Description Create a SiteWorx backup.
Input Parameters
Name Type Notes Required?
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*
* indicates that it’s actually required, but probably already has a valid default value
Action: delete
Added in version 4.7.0-339
Description Delete a siteworx backup.
Input Parameters
Name Type Notes Required?
backups struct (string) Example Values
example.com-partial-Nov.15.2017-20.44.18.tgz, example.com-full-Nov.15.2017-20.43.37.tgz
Yes
Action: deleteCron
Added in version 4.7.0-339
Description Delete a scheduled backup.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-30 use /siteworx/backup/schedule action=delete
Action: listAllBackups
Added in version 4.8.0-393
Description List all backups created manually.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’filepath’ => ’/home/example/example.com/iworx-backup/example.com-full-Nov.15.2017-20.43.37.tgz’,
’filename’ => ’example.com-full-Nov.15.2017-20.43.37.tgz’,
’filesize’ => ’71.40 KB’,
’type’ => ’##LG_FULLBACKUP##’,
’filedate’ => 1510796623,
’complete’ => true,
),
1 =>
array (
’filepath’ => ’/home/example/example.com/iworx-backup/example.com-partial-Nov.15.2017-20.44.18.tgz’,
’filename’ => ’example.com-partial-Nov.15.2017-20.44.18.tgz’,
’filesize’ => ’146.00 KB’,
’type’ => ’##LG_PARTIALBACKUP##’,
’filedate’ => 1510796668,
’complete’ => true,
),
),
)
Action: listDailyBackups
Added in version 4.8.0-393
Description List all current daily backups.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listMonthlyBackups
Added in version 4.8.0-393
Description List all current monthly backups.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listWeeklyBackups
Added in version 4.8.0-393
Description List all current weekly backups.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: restore
Added in version 4.7.0-339
Description Restore a partial siteworx backup.
Input Parameters
Name Type Notes Required?
filetype string Example Values
local, remote
Yes
file string Yes
Action: schedule
Added in version 4.7.0-339
Description Schedule a SiteWorx backup.
Warning This action has been deprecated as of version 4.8.0-393. 2010-11-30 use /siteworx/backup/schedule action=create
Input Parameters
Name Type Notes Required?
type string Example Values
full, partial, structure
Yes
location string Example Values
siteworx, local, ftp, scp
Yes
frequency string Example Values
daily, weekly, monthly
Example Default Value
daily
Yes
email_address string Example Default Value
user@example.com
No*
hour string Example Values
*, */2, */4, */6, 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
 Part III: SiteWorx API Spec Up Part III: SiteWorx API Spec Chapter 61: Controller: /siteworx/backup/schedule 

(C) 2017 by InterWorx LLC