The following endpoint returns the ping status of the CA Gateway server for a group.

https://{host}:9444/{management.endpoints.web.base-path}/health/{group}/ping

Where:

  • {host} is the is the hostname or IP address of the CA Gateway host server.
  • {management.endpoints.web.base-path}  is the value of the management.endpoints.web.base-path parameter in the  application.yml  configuration file. 
  • {group} is one of the groups listed by the health endpoint.

To enable this health endpoint, you must configure the management.endpoints.web.exposure.include parameter in the  application.yml file. 

For example, to check the ping status for the custom group.

https://localhost:9444/cagw/management/actuator/health/custom/ping

If the server is up, this endpoint will return the following response.

{"status":"UP"}