Using the health check API

To check the status of the Gateway, you can use the health check web API (/apphealth in the Gateway) to ping the public interface to verify that important services are running.

API request

To check the Gateway's health, use the health check URL with any browser, with curl on the Gateway's public interface, or from a load balancer.

$ curl -k https://bcgateway.example.com/apphealth

Example responses

Responses contain JSON strings with additional data, which may include HTTP status codes where possible.

{"control": "up", 
  "ike": "up"}

{"control": "up", 
  "ike": "down"}

{"control": "down", 
  "ike": "unknown"}

{"reason": "Internal Server Error", 
  "code": 500, 
  "message": "An error occurred while processing your request.
            Please contact your System Administrator", 
  "title": "Oops!"}

{"error": 503}