To enable this endpoint, you must configure the management.endpoints.web.exposure.include parameter. 

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

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

See the table below for a description of each field.

Field

Value

​{host}

The hostname or IP address of the CA Gateway host server

{port}

The port of the CA Gateway service

{management.endpoints.web.base-path}

The value of the management.endpoints.web.base-path configuration parameter 

{group} 

One of the groups listed by the Health endpoint

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"}