Perform a Health Check for Load Balancers

You can perform regular health checks for your Workspace ONE UEM load balancers to verify connectivity and avoid a down server. Learn how to perform an official health check to test connectivity to the Console, Device Services, Device Management, and Self-Service Portal endpoints.

You can use the following official health check test for your load balancer(s) to test connectivity to the Console, Device Services, Device Management, and Self-Servicesnaggitsn Portal endpoints.

1. Configure the following in your load balancer(s), depending on the application server(s) being load-balanced:

   • Console – GET to https://<host>/airwatch/awhealth/v1

   • Device Services – GET to https://<host>/deviceservices/awhealth/v1

   • Device Management – GET to https://<host>/devicemanagement/awhealth/v1

   • Self-Service Portal – GET to https://<host>/mydevice/awhealth/v1

   • MDM API – GET to https://<host>/api/mdm/hc

   • System API – GET to https://<host>/api/system/hc

   • MEM API – GET to https://<host>/api/mem/hc

   • MAM API – GET to https://<host>/api/mam/hc

2. Select a frequency interval for applicable health checks. VMware default recommendation is 5 seconds.

3. Select a timeout value for applicable health checks. VMware default recommendation is 16 seconds.

4. Add your load balancer IP address – or addresses if multiple – in the Workspace ONE UEM console under System Settings >  Admin >  Monitoring.

   Configure this page to determine which tools can monitor whether the application server(s) are up. These can include the Admin Console, Device Services, Device Management, and Self-Service Portal. By default any load balancer or monitoring tool can perform this monitoring. For security purposes you can control this monitoring by IP address.

   For example, you can set up a load balancer to detect if a given application server is up. The Admin Monitoring settings page lets you allow certain IP addresses that can access this page. By default, any IP address is allowed if no IP addresses are defined.

5. Restart the application pools.

When you test the health check endpoints you should receive a 200 response from the HTTP GET request and a JSON response with the Workspace ONE UEM version. If you receive a 403 response for the Console or Device Services endpoint ensure you restart the app pools after entering the IP address in the Workspace ONE UEM console. In the event that a health check is failing, we should not be passing traffic to that node.