API Command: check_health
The check_health command returns XML data containing information about the BeyondTrust Appliance B Series.
The API account used to issue this command must have read-only or full access to the command API.
XML Response for check_health Query
| <appliance> |
The hostname of the B Series Appliance. Also contains an id attribute that contains the B Series Appliance's GUID. |
| <version> |
The version number and build number of the BeyondTrust software running on the B Series Appliance. |
| <success> |
Integer value (1 or 0) indicating if the health check of the B Series Appliance was successful. |
| <error_message> |
Returns an error message if a problem is found. If no error is found, this element will not be returned. |
| <failover_role> |
The role the B Series Appliance plays in the failover relationship. Can be one of none (if failover is not configured), primary, or backup. |
| <enabled_shared_ips> |
Contains an <ip> element for each IP address which is shared between the primary and backup B Series Appliances. If no shared IP addresses are enabled or if failover is not configured, this element is not returned. |
| <last_data_sync_time> |
The date and time at which the last data sync occurred between the primary and backup B Series Appliances. Data is returned in ISO 8601 format. Also contains a ts attribute which displays the data sync time as a UNIX timestamp (UTC). If failover is not configured, this element is not returned. |
| <last_data_sync_status> |
Contains a string showing the status of the last data sync. If failover is not configured, this element is not returned. |
Query Example: check_health
| check_health |
https://access.example.com/api/command?action=check_health |
HTTP Status Check
In addition to using the API command above, you can use https://access.example.com/check_health to check the health of a B Series Appliance. This returns an HTTP status of 200 if the probe is successful and 500 (Server Error) if not. While you will see a simple human-readable message showing success or failure, no other data is exposed.
