Chapter 44: Controller: /nodeworx/notice Up Part II: NodeWorx API Spec Chapter 46: Controller: /nodeworx/packages 

45 Controller: /nodeworx/overview

Action: editProfile
Added in version 4.8.3-414
Description Edit the currently authenticated users’ profile.
Input Parameters
Name Type Notes Required?
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
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: listHostname
Added in version 4.7.0-339
Description List the hostname of the system.
Sample output
array (
’status’ => 0,
’payload’ => ’apidoc.interworx.com’,
)
Action: listIsClusterable
Added in version 5.0.14-579
Description List the clusterable status of this license.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’is_clusterable’ => true,
),
)
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: listLoadAverage
Added in version 4.7.0-339
Description Lists the one, five, and fifteen-minute load averages.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’one_minute’ => ’0.36’,
’five_minute’ => ’0.20’,
’fifteen_minute’ => ’0.33’,
),
)
Action: listServiceStatus
Added in version 4.7.0-339
Description Lists the status and port numbers of InterWorx-managed services.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’httpd’,
’name’ => ’##LG_APACHE##’,
’ports’ => ’80, 443’,
’page’ => ’/nodeworx/http’,
’ctrl’ => ’/nodeworx/http’,
’is_running’ => 1,
),
1 =>
array (
’id’ => ’pop3’,
’name’ => ’##LG_POP3##’,
’ports’ => ’110’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/pop3’,
’is_running’ => 1,
),
2 =>
array (
’id’ => ’pop3-ssl’,
’name’ => ’##LG_SECURE_POP3##’,
’ports’ => ’995’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/spop3’,
’is_running’ => 1,
),
),
)
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: listVPSStatus
Added in version 5.0.14-579
Description List the VPS status of the system.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’is_vps’ => true,
),
)
Action: listVPSVendor
Added in version 5.0.14-579
Description List the VPS status of the system.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’vps_vendor’ => ’xen’,
),
)
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 (
’theme’ => ’calliope’,
’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, Users, Lang, Themes, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Simplescripts, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailPop3, MailSpop3, MailImap, MailSimap, MailSpam, MailVirus, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, ...
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 44: Controller: /nodeworx/notice Up Part II: NodeWorx API Spec Chapter 46: Controller: /nodeworx/packages 

(C) 2018 by InterWorx LLC