Obtaining simple health check data of Developer Portal sites by using a REST API call

Call a simple health check API from your external load balancer to dynamically determine whether a specific Developer Portal site in a cluster is working. This API call can be used by a load balancer to help determine where to route traffic.

About this task

You can use the site health REST API to determine whether a particular Developer Portal site is running. The site health API returns the current system time of the site if both the database and web server are running. This API is fast and puts no load on the system, so it is ideal for use with load balancers to help them determine where to route traffic.

Procedure

To call the site health REST API, append /health to the end of your Developer Portal site URL in your web browser, as follows:

site_url/health

Where site_url is the URL of the Developer Portal site that you want to check.

If both the database and web server of the site are running, the web browser returns the current system time. For example:

1511367695

If either the database or the web server of the site is not running, the web browser returns an error that the site can't be reached.

If you do get an error from the/health endpoint, refer to the must gather logs page and obtain the portal-www web logs, so that you can see more information on the error.