All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Basic health checks on an API Manager node can be performed by connecting to relevant ports. Please refer the following table for the ports that can be used for health checks in a fully distributed deployment. 

API Manager ProfilePorts that can be used for health checks
Gateway Manager9763 (HTTP), 9443 (HTTPS)
Gateway Worker8280 (HTTP), 8243 (HTTPS)
API Store9673 (HTTP), 9443 (HTTPS)
API Publisher9673 (HTTP), 9443 (HTTPS)
Traffic Manager5672 (TCP), 7611 (TCP), 7711 (TCP)
Key Manager9673 (HTTP), 9443 (HTTPS)

 Please see API Manager Profiles documentation for more information on each profile. 

Even though the ports are responding, there might be scenarios where the Services are not properly started. Hence, advisable to use Service level health checks as well. As an example, API Manager by default is shipped with the simple axis2 service named 'Version'. This service returns the version of the running API Manager instance. 

A sample curl command and the response from the Version service is shown below.

curl command:

curl -v http://<HOSTNAME>:<PORT>/services/Version
curl -v http://localhost:9763/services/Version


<ns:getVersionResponse xmlns:ns=""><return>WSO2 API Manager-2.1.0</return></ns:getVersionResponse>

  • No labels