API Gateway Availability

Edit online

API Gateway provides the capability to monitor the health of API Gateway and report the overall health of API Gateway. Each health check request displays a status field as the first entry. The status can have the values green, yellow or red describing the overall status of the components to check. This means that when any of the components signals a problem, then the status is set to red.

API Gateway provides the following REST API and the resources to monitor the health of API Gateway:

  • GET /gateway/availability/admin: Retrieves the availability and health status of the API Gateway administration service (UI, Dashboards, Admin REST API).
  • GET /gateway/availability/engine: Retrieves the availability and health status of the Gateway policy enforcement engine (ElasticSearch cluster, IS and Terracotta).
  • GET /gateway/availability/externalServices: Retrieves the availability of external services accessed by API Gateway.
  • GET /gateway/availability/all: Retrieves the availability of the administration service of the policy enforcement engine and of the external services accessed by API Gateway.

For details about the REST API, see https://github.com/SoftwareAG/webmethods-api-gateway/blob/10.11/apigatewayservices/APIGatewayAvailability.json.

Note:
  • To perform the following API Gateway Availability REST calls you must have the View Administration Configuration privileges.
    • GET /gateway/availability/externalServices
    • GET /gateway/availability/all
  • To perform the following API Gateway Availability REST calls you must be a valid API Gateway user.
    • GET /gateway/availability/admin
    • GET /gateway/availability/engine

You can use the existing health check request GET http://localhost:5555/rest/apigateway/health, without any authentication being set, to retrieve the health of API Gateway that monitors the availability and health status of Kubernetes and Docker containers . This returns a HTTP 200 response without additional data.