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

Required?

Example Values

Default Values

Notes

type

string

Yes

full, partial, structure

location

string

Yes

siteworx, local, ftp, scp

email_address

string

No*

user@example.com

domain_options

string

No*

single-domain, multi-domain

multi-domain

exclude_extensions

struct (string)

No

Examples: .zip, .tar.gz, etc

* 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

Required?

Example Values

Default Values

Notes

backups

struct (string)

Yes

example.com+full-Jan.12.2020-00.51.13.tgz, example.com+partial-Jan.12.2020-00.51.13.tgz

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: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

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-Jan.12.2020-00.51.13.tgz',
      'filename' => 'example.com+full-Jan.12.2020-00.51.13.tgz',
      'filesize' => '81.27 KB',
      'filesize_bytes' => 81272,
      'type' => '##LG_FULLBACKUP##',
      'domain_options' => '',
      'filedate' => 1578808273,
      'complete' => true,
    ),
    1 =>
    array (
      'filepath' => '/home/example/example.com/iworx-backup/example.com+partial-Jan.12.2020-00.51.13.tgz',
      'filename' => 'example.com+partial-Jan.12.2020-00.51.13.tgz',
      'filesize' => 0,
      'filesize_bytes' => 81272,
      'type' => '##LG_PARTIALBACKUP##',
      'domain_options' => '',
      'filedate' => 1578808273,
      'complete' => false,
    ),
  ),
  'reply_code' => 205,
)

Action: listDailyBackups

Added in Version

4.8.0-393

Description

List all current daily backups.

Sample Output

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

Action: listMonthlyBackups

Added in Version

4.8.0-393

Description

List all current monthly backups.

Sample Output

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

Action: listWeeklyBackups

Added in Version

4.8.0-393

Description

List all current weekly backups.

Sample Output

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

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: restore

Added in Version

4.7.0-339

Description

Restore a partial siteworx backup.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

filetype

string

Yes

local, remote

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

Required?

Example Values

Default Values

Notes

type

string

Yes

full, partial, structure

location

string

Yes

siteworx, local, ftp, scp

frequency

string

Yes

daily, weekly, monthly

daily

email_address

string

No*

user@example.com

domain_options

string

No*

single-domain, multi-domain

multi-domain

hour

string

Yes

*, */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

* indicates that it’s actually required, but probably already has a valid default value.

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.