Chapter 89: Controller: /siteworx/notice Up Part III: SiteWorx API Spec Chapter 91: Controller: /siteworx/prefs 

90 Controller: /siteworx/overview

Action: editProfile
Added in version 4.8.2-411
Description Edit the currently authenticated users’ profile.
Input Parameters
Name Type Notes Required?
language string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
password string No
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: fail
Added in version n/a
Description Magic function - test for failure mechanism.
Action: listAccountDetails
Added in version 4.7.0-339
Description List siteworx account details.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’username’ => ’example’,
’email’ => ’user@example.com’,
’masterdomain’ => ’example.com’,
’homedir’ => ’/home/example’,
’domains’ =>
array (
0 => ’example.com’,
1 => ’secondary.com’,
),
’remaining_diskspace’ => ’unlimited’,
’options’ =>
array (
’storage’ => 999999999,
’bandwidth’ => 999999999,
’email_aliases’ => 999999999,
’email_autoresponders’ => 999999999,
’email_boxes’ => 999999999,
’email_groups’ => 999999999,
’ftp_accounts’ => 999999999,
’mysql_dbs’ => 999999999,
’mysql_db_users’ => 999999999,
’pointer_domains’ => 999999999,
’slave_domains’ => 999999999,
’subdomains’ => 999999999,
’backup’ => true,
’cgi_access’ => true,
’crontab’ => true,
’dns_records’ => true,
’ssl’ => true,
’burstable’ => true,
’save_xfer_logs’ => true,
),
),
)
Action: listAvailableDiskSpace
Added in version 4.7.0-339
Description List available disk space action.
Sample output
array (
’status’ => 0,
’payload’ => ’unlimited’,
)
Action: listLicenseKey
Added in version 4.7.0-339
Description List the InterWorx license key.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’licence_key’ => ’INTERWORX_APIDOC2’,
),
)
Action: listMasterDomain
Added in version 4.7.0-339
Description List the current master domain.
Sample output
array (
’status’ => 0,
’payload’ => ’example.com’,
)
Action: listPhpInstallMode
Added in version 4.7.0-339
Description Get the mode php is running under.
Sample output
array (
’status’ => 0,
’payload’ => ’mod_suphp’,
)
Action: listVersion
Added in version 4.7.0-339
Description List the version of InterWorx installed.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’version’ => ’6.1.23-1488’,
),
)
Action: listWorkingDomain
Added in version 4.7.0-339
Description List the current working domain.
Sample output
array (
’status’ => 0,
’payload’ => ’example.com’,
)
Action: queryEditProfile
Added in version 5.1.0-838
Description Displays the information available to the action "editProfile".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’language’ => ’en-us’,
’menu_style’ => ’big’,
’password’ => NULL,
’confirm_password’ => NULL,
),
)
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Input Parameters
Name Type Notes Required?
controller string Example Values
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsSlave, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Simplescripts, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, Backup, BackupSchedule, Prefs, Notice, Logout
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 89: Controller: /siteworx/notice Up Part III: SiteWorx API Spec Chapter 91: Controller: /siteworx/prefs 

(C) 2018 by InterWorx LLC