Chapter 3: Controller: /nodeworx/apikey Up Part II: NodeWorx API Spec Chapter 5: Controller: /nodeworx/cluster 

4 Controller: /nodeworx/backup

Required Permissions "BRESTORE"
Action: fail
Added in version n/a
Description Magic function - test for failure mechanism.
Action: fullbackup
Added in version 4.8.0-393
Description Creates a full backup for the specified domains.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
Yes
email string Help Entry
Check the box and enter a valid email address here to be notified by email once the backup of the selected SiteWorx accounts has completed.
No
Action: queryAccounts
Added in version 4.8.0-393
Description Query the backups based on the selected reseller.
Input Parameters
Name Type Notes Required?
reseller string Example Values
all, 1, 16
Yes
Action: queryBackups
Added in version 4.8.0-393
Description Get a list of backups given a domain.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Action: restore
Added in version 4.7.0-339
Description Restore a given backup (local).
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
file string Example Values
example.com+partial-Jul.11.2018-15.29.49.tgz, example.com+full-Jul.11.2018-15.29.08.tgz
Yes
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: structureonly
Added in version 4.8.0-393
Description Creates a structure only backup for the specified domains.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
Yes
email string Help Entry
Check the box and enter a valid email address here to be notified by email once the backup of the selected SiteWorx accounts has completed.
No
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 3: Controller: /nodeworx/apikey Up Part II: NodeWorx API Spec Chapter 5: Controller: /nodeworx/cluster 

(C) 2018 by InterWorx LLC