All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reviewed changes

Basic health checks checks can be performed on an API Manager node can be performed by connecting to relevant ports. Please refer See 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 For more information on each profile, see API Manager Profiles

Even There can be scenarios where even though the ports are responding, there might be scenarios where the Services are not properly started. Hence, It is advisable to use Service level health checks as well. As an to ensure that the services are started. For 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 that is running currently

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

curl cURL command:

Localtab Group
Code Block
curl -v http://<HOSTNAME>:<PORT>/services/Version
Code Block
curl -v http://localhost:9763/services/Version