API Command: check_health

The check_health command returns XML data containing information about the Secure Remote Access Appliance.

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Privileged Remote Access API. 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


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


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


Integer value (1 or 0) indicating if the health check of the appliance was successful.


Returns an error message if a problem is found. If no error is found, this element will not be returned.


The role the appliance plays in the failover relationship. Can be one of none (if failover is not configured), primary, or backup.


Contains an <ip> element for each IP address which is shared between the primary and backup appliances. If no shared IP addresses are enabled or if failover is not configured, this element is not returned.


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). If failover is not configured, this element is not returned.


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

  • 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 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.