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 |
Required? |
Example Values |
Default Values |
Notes |
|---|---|---|---|---|---|
|
struct (string) |
Yes |
example.com |
||
|
string |
No |
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. |
Action: queryAccounts¶
- Added in Version
4.8.0-393
- Description
Query the backups based on the selected reseller.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
|---|---|---|---|---|---|
|
string |
Yes |
all, 1, 2 |
Action: queryBackups¶
- Added in Version
4.8.0-393
- Description
Get a list of backups given a domain.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
|---|---|---|---|---|---|
|
string |
Yes |
example.com, secondary.com |
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 |
Required? |
Example Values |
Default Values |
Notes |
|---|---|---|---|---|---|
|
string |
Yes |
example.com, secondary.com |
||
|
string |
Yes |
example.com+full-Jan.12.2020-00.51.13.tgz, example.com+partial-Jan.12.2020-00.51.13.tgz |
||
|
struct (integer) |
No* |
1 |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
|---|---|---|---|---|---|
|
struct (string) |
Yes |
example.com |
||
|
string |
No |
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. |
Action: targetedRestore¶
- Added in Version
7.3.0-1840
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
|---|---|---|---|---|---|
|
string |
Yes |
|||
|
string |
Yes |
|||
|
struct (string) |
No |
|||
|
struct (string) |
No |
Action: win¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.