API Command: check_health

The check_health command returns XML data containing information about the Bomgar Appliance, specifically including information needed for failover purposes.

In order to issue the check_health command, you will need to supply the username and password for a Bomgar user account. That account must have the permission Allowed to Use Command API along with the permission Is Administrator.

XML Response for check_health Query

<appliance>

The hostname of the appliance. Also contains an id attribute that contains the appliance's GUID.

<version>

The version number and build number of the Bomgar software running on the appliance.

<success>

Integer value (1 or 0) indicating if the health check of the 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 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 appliances. If no shared IP addresses are enabled, this element will not be returned.

<last_data_sync_time>

The date and time at which the last data sync occurred between the primary and backup appliances. Data is returned in ISO 8601 format. Also contains a ts attribute which displays the data sync time as a UNIX timestamp (UTC).

<last_data_sync_status>

Contains a string showing the status of the last data sync.

Query Example: check_health

check_health https://support.example.com/api/command?username=test&password=test&action=check_health

HTTP Status Check

In addition to using the API command above, you can use https://support.example.com/check_health to check the health of an 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.