Controller: /siteworx/overview¶
Action: editProfile
¶
- Added in Version
4.8.2-411
- Description
Edit the currently authenticated users’ profile.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh |
en-us |
|
|
string |
No |
|||
|
string |
No |
|||
|
string |
No |
Confirm the password field by providing it again. Must match the password provided. |
* 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: listAccountConfig
¶
- Added in Version
6.4.0-1705
- Description
List all SiteWorx Level Config Data.
Action: listAccountDetails
¶
- Added in Version
4.7.0-339
- Description
List siteworx account details.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'username' => 'example',
'email' => '[email protected]',
'masterdomain' => 'example.com',
'homedir' => '/home/example',
'domains' =>
array (
0 => 'example.com',
1 => 'secondary.com',
),
'remaining_diskspace' => 'unlimited',
'options' =>
array (
'storage' => 999999999.0,
'bandwidth' => 999999999.0,
'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,
'mailman' => true,
'ssl' => true,
'burstable' => true,
'save_xfer_logs' => true,
),
),
'reply_code' => 205,
)
Action: listAvailableDiskSpace
¶
- Added in Version
4.7.0-339
- Description
List available disk space action.
Sample Output¶
array (
'status' => 0,
'payload' => 'unlimited',
'reply_code' => 205,
)
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',
),
'reply_code' => 205,
)
Action: listMasterDomain
¶
- Added in Version
4.7.0-339
- Description
List the current master domain.
Sample Output¶
array (
'status' => 0,
'payload' => 'example.com',
'reply_code' => 205,
)
Action: listPhpInstallMode
¶
- Added in Version
4.7.0-339
- Description
Get the mode php is running under.
Sample Output¶
array (
'status' => 0,
'payload' => 'php-fpm',
'reply_code' => 205,
)
Action: listVersion
¶
- Added in Version
4.7.0-339
- Description
List the version of InterWorx installed.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'version' => '7.13.39-2749',
),
'reply_code' => 205,
)
Action: listWorkingDomain
¶
- Added in Version
4.7.0-339
- Description
List the current working domain.
Sample Output¶
array (
'status' => 0,
'payload' => 'example.com',
'reply_code' => 205,
)
Action: queryAccountConfig
¶
- Added in Version
6.4.0-1705
- Description
Query SiteWorx Level Config Data.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
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' => NULL,
'password' => NULL,
'confirm_password' => NULL,
),
'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 |
---|---|---|---|---|---|
|
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: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.