The following endpoint returns information on the CA Gateway server health.

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

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

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

For example:

{"status":"UP","groups":["custom"]}

See below for a description of each value.

status

The ping status of the CA Gateway server.

groups

The list of user groups defined under the management.endpoint parameter.