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 Profile | Ports that can be used for health checks |
|---|---|
| Gateway Manager | 9763 (HTTP), 9443 (HTTPS) |
| Gateway Worker | 8280 (HTTP), 8243 (HTTPS) |
| API Store | 9673 (HTTP), 9443 (HTTPS) |
| API Publisher | 9673 (HTTP), 9443 (HTTPS) |
| Traffic Manager | 5672 (TCP), 7611 (TCP), 7711 (TCP) |
| Key Manager | 9673 (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:
response:
<ns:getVersionResponse xmlns:ns="http://version.services.core.carbon.wso2.org"><return>WSO2 API Manager-2.1.0</return></ns:getVersionResponse>