Chapter 15: Controller: /nodeworx/ftp Up Part II: NodeWorx API Spec Chapter 17: Controller: /nodeworx/help 

16 Controller: /nodeworx/health

Required Permissions "SETTINGS"
Action: edit
Added in version 4.7.0-339
Description Edit Problem settings - action has conditional inputs not documented.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
repeat_rate string Help Entry
The repeat rate controls how often notices are sent for the conditions checked by the Problem Detectors.
Example Values
once, 0, 30, 60, 1440, 10080
Example Default Value
60
No*
run_time string Help Entry
Controls how often the Detector is run. Detection is triggered by the InterWorx CRON jobs.
Example Values
fively, fifteenly, hourly, quad_daily, daily, weekly, monthly
Example Default Value
hourly
No*
sender_address string Example Values
default
Example Default Value
default
No*
sender_name string Example Values
default
Example Default Value
default
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editRecipients
Added in version 4.7.0-339
Description Change the recipients of a code.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
email_recipients struct (string) Example Values
2, 3, nw1, nw54, nw168
Example Default Value
["2"]
No
banner_recipients struct (string) Help Entry
Banner notices are delivered through the InterWorx interface as a banner across the top of each screen
Example Values
2, 3, nw1, nw54, nw168
Example Default Value
["2"]
No
email_only struct (string) Help Entry
Add direct email addresses to send to
No
Action: queryCodeHistory
Added in version 4.7.0-339
Description Get the code history for a specific code.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
Action: queryCodesByEmail
Added in version 4.8.0-393
Description Lists codes that the given email address may recieve.
Input Parameters
Name Type Notes Required?
email string Yes
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’repeat_rate’ => ’60’,
’run_time’ => ’hourly’,
’sender_address’ => ’default’,
’sender_name’ => ’default’,
’code’ => ’CLAMAV_NOT_WORKING’,
),
)
Action: queryEditRecipients
Added in version 5.1.0-838
Description Displays the information available to the action "editRecipients".
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’email_recipients’ =>
array (
0 => ’2’,
),
’banner_recipients’ =>
array (
0 => ’2’,
),
’email_only’ =>
array (
),
’code’ => ’CLAMAV_NOT_WORKING’,
),
)
Action: queryHealthStatus
Added in version 5.0.14-579
Description Lists real-time status of detectors (actually runs each, be careful about load).
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’code’ => ’CLAMAV_NOT_WORKING’,
’name’ => ’##LG_CLAMAV_NOT_WORKING##’,
’status’ => 0,
’type’ => ’##LG_PROBLEM_SYSTEM_MONITORS##’,
’message’ => ’’,
),
1 =>
array (
’code’ => ’EXTERNAL_NFS_CANNOT_CONNECT’,
’name’ => ’##LG_EXTERNAL_NFS_CANNOT_CONNECT##’,
’status’ => 0,
’type’ => ’##LG_PROBLEM_SYSTEM_MONITORS##’,
’message’ => ’’,
),
2 =>
array (
’code’ => ’MAIL_LOGGING_STOPPED’,
’name’ => ’##LG_MAIL_LOGGING_STOPPED##’,
’status’ => 0,
’type’ => ’##LG_PROBLEM_SYSTEM_MONITORS##’,
’message’ => ’’,
),
),
)
Action: removeTargetFromCode
Added in version 4.8.0-393
Description Removes a specific target from a code. Use queryCodesByEmail() to see targets.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
target string Yes
 Chapter 15: Controller: /nodeworx/ftp Up Part II: NodeWorx API Spec Chapter 17: Controller: /nodeworx/help 

(C) 2017 by InterWorx LLC