Controller: Backup

API Controller /nodeworx/backup
Required Permissions ["BRESTORE"]
Action Description
fullbackup Creates a full backup for the specified domains.
queryAccounts Query the backups based on the selected reseller.
queryBackups Get a list of backups given a domain.
restore Restore a given backup (local).
structureonly Creates a structure only backup for the specified domains.

Action: fullbackup (Added in version 4.8.0-393)

Creates a full backup for the specified domains.

Input Parameters

Name Type Notes Required?
domains struct (string)
Example Values
mydomain.com, 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)

Query the backups based on the selected reseller.

Input Parameters

Name Type Notes Required?
reseller string
Example Values
all, 1, 2
 Yes

Action: queryBackups (Added in version 4.8.0-393)

Get a list of backups given a domain.

Input Parameters

Name Type Notes Required?
domain string
Example Values
mydomain.com, example.com, secondary.com
 Yes

Action: restore

Restore a given backup (local).

Input Parameters

Name Type Notes Required?
domain string
Example Values
mydomain.com, example.com, secondary.com
 Yes
file string
Example Values
example.com-partial-May.08.2012-20.29.31.tgz, example.com-full-May.08.2012-20.23.42.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)

Creates a structure only backup for the specified domains.

Input Parameters

Name Type Notes Required?
domains struct (string)
Example Values
mydomain.com, 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