Note
You are viewing the documentation for an older release of Interworx (7.7). To see documentation for the current generally available release of Interworx, click here: 7.13.
Controller: /nodeworx/plugins¶
- Required Permissions
PLUGINS
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit a plugin.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
auto-enable-shell-account, eventhooks, softaculous, acronis, autoset-spamprefs, catchall-account-option, cloudflare, cloudlinux, disable-local-delivery, domain-email-create, external-nfs-quota, hello, history, imunifyav, lets-encrypt, license-api2, litespeed, r1soft, siteworx-backups-cron |
||
|
integer |
No* |
1, 0 |
0 |
|
|
integer |
No |
1 |
||
|
struct (integer) |
No* |
1, 2 |
* 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: listPlugins
¶
- Added in Version
4.8.0-393
- Description
Get list of plugins.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'name' => 'softaculous',
'label' => 'Softaculous',
'desc' => 'Softaculous is a fast, well designed auto installer, and it installs all scripts in just one step',
'status' => true,
'cat' => '##LG_SCRIPT_INSTALLERS##',
'qh' => 'From <a href=\'http://www.softaculous.com\' target=\'_blank\'>softaculous.com</a><br><i>Softaculous is a great Auto Installer having 104 great scripts and we are still adding more. Softaculous is ideal for Web Hosting companies and it could give a significant boost to your sales. These scripts cover most of the uses a customer could ever have. We have covered a wide array of Categories so that everyone could find the required script one would need to power their Web Site. The best part is we keep on adding new scripts which we know will satisfy the needs of a User.</i> ',
'error' => '',
),
1 =>
array (
'name' => 'acronis',
'label' => 'Acronis',
'desc' => 'Cloud backup service for automatic and manual backups',
'status' => false,
'cat' => '##LG_BACKUP_RESTORE##',
'qh' => 'A backup agent must be installed on the machine prior to enabling the plugin.',
'error' => '',
),
2 =>
array (
'name' => 'r1soft',
'label' => 'R1Soft CDP Access',
'desc' => 'R1Soft Backup Siteworx Integration',
'status' => false,
'cat' => '##LG_BACKUP_RESTORE##',
'qh' => 'This plugin allows the SiteWorx user to automatically login to their account on an R1Soft CDP Server. By default, all SiteWorx users have access. Access can be revoked on a per SiteWorx account basis by editing the SiteWorx package of the account in question, or at SiteWorx account creation time. This plugin requires the R1Soft Agent installed on the interworx server.',
'error' => '',
),
),
'reply_code' => 205,
)
Action: queryEdit
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “edit”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
auto-enable-shell-account, eventhooks, softaculous, acronis, autoset-spamprefs, catchall-account-option, cloudflare, cloudlinux, disable-local-delivery, domain-email-create, external-nfs-quota, hello, history, imunifyav, lets-encrypt, license-api2, litespeed, r1soft, siteworx-backups-cron |
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.