Skip to main content
Skip table of contents

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.

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

Example responses

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

ScenarioResponse JSON
Control channel and IKE are working as expected

‚Äč

TEXT
{"control": "up", 
  "ike": "up"}
Control channel is up, IKE is down
TEXT
{"control": "up", 
  "ike": "down"}
Control channel is down, IKE status is unknown
TEXT
{"control": "down", 
  "ike": "unknown"}
Error occurred during response processing
TEXT
{"reason": "Internal Server Error", 
  "code": 500, 
  "message": "An error occurred while processing your request.
            Please contact your System Administrator", 
  "title": "Oops!"}
Rate limit reached 
The Gateway allows 1 request every 4 seconds per source IP
TEXT
{"error": 503}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.