Controller: Health

API Controller /nodeworx/health
Required Permissions ["SETTINGS"]
Action Description
edit Edit Problem settings - action has conditional inputs not documented.
editRecipients Change the recipients of a code.
listHealthStatus Lists real-time status of detectors (actually runs each, be careful about load).
queryCodeHistory Get the code history for a specific code.
queryCodesByEmail Lists codes that the given email address may recieve.
removeTargetFromCode Removes a specific target from a code. Use queryCodesByEmail() to see targets.

Action: edit (Added in version 4.4.0-303)

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, MISSING_NAMEVIRTUALHOSTCONF_FILE, MYSQL_MISSING_OLD_PASSWORDS_ENTRY, 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, MODIFIED_SSH_BINS, MOD_LOG_INSTALLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, YUM_UPDATE_FAILING
 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.4.0-303)

Change the recipients of a code.

Input Parameters

Name Type Notes Required?
code string
Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MISSING_NAMEVIRTUALHOSTCONF_FILE, MYSQL_MISSING_OLD_PASSWORDS_ENTRY, 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, MODIFIED_SSH_BINS, MOD_LOG_INSTALLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, YUM_UPDATE_FAILING
 Yes
email_recipients struct (string)
Example Values
2, 3, nw1, nw2, nw37
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, nw2, nw37
Example Default Value
["2"]
 No
email_only struct (string)
Help Entry
Add direct email addresses to send to
 No

Action: listHealthStatus (Added in version 4.4.0-303)

Lists real-time status of detectors (actually runs each, be careful about load).

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'code' => 'MODIFIED_SSH_BINS',
      'name' => '##LG_PROBLEM_MODIFIED_SSH_BINS##',
      'is_problem' => 0,
      'is_sw_problem' => 0,
      'is_rsl_problem' => 0,
      'message' => '',
    ),
    1 => 
    array (
      'code' => 'MOD_LOG_INSTALLED',
      'name' => '##LG_PROBLEM_MOD_LOG##',
      'is_problem' => 0,
      'is_sw_problem' => 0,
      'is_rsl_problem' => 0,
      'message' => '',
    ),
    2 => 
    array (
      'code' => 'QUOTAS',
      'name' => '##LG_PROBLEM_QUOTAS##',
      'is_problem' => 0,
      'is_sw_problem' => 0,
      'is_rsl_problem' => 0,
      'message' => '',
    ),
  ),
)

Action: queryCodeHistory (Added in version 4.7.0-336)

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, MISSING_NAMEVIRTUALHOSTCONF_FILE, MYSQL_MISSING_OLD_PASSWORDS_ENTRY, 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, MODIFIED_SSH_BINS, MOD_LOG_INSTALLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, YUM_UPDATE_FAILING
 Yes

Action: queryCodesByEmail (Added in version 4.8.0-393)

Lists codes that the given email address may recieve.

Input Parameters

Name Type Notes Required?
email string Yes

Action: removeTargetFromCode (Added in version 4.8.0-393)

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, MISSING_NAMEVIRTUALHOSTCONF_FILE, MYSQL_MISSING_OLD_PASSWORDS_ENTRY, 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, MODIFIED_SSH_BINS, MOD_LOG_INSTALLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, YUM_UPDATE_FAILING
 Yes
target string Yes