The heartbeat endpoint verifies that the PingAccess server is running and, depending on security settings, displays details about the configuration.
You can make this call to any active PingAccess listener and on any node in a PingAccess cluster. For example, with default port configurations, a clustered console replica responds to this endpoint on port 9000, and a clustered engine responds to it on port 3000.
/pa/heartbeat.ping
This endpoint returns a short or detailed status for the target PingAccess server, based on the value of the enable.detailed.heartbeat.response parameter in run.properties. Load balancers can use this endpoint to determine the status of PingAccess.
The https://hostname:3000/pa/heartbeat.ping
.
If you selected the Use context root as reserved
resource base path check box on your PingAccess application, this feature creates an instance of any
reserved PingAccess resources under the application’s
context root. As such, the context root of the application needs to prepend the reserved
context application root (/pa
by default) in any file paths that reference
it.
If the context root of your application is myApp
, the path to
the heartbeat endpoint would be myApp/pa/heartbeat.ping
and the
URL would be https://hostname:3000/myApp/pa/heartbeat.ping
instead.
If an error is returned, this indicates that the PingAccess instance associated with the endpoint is down.
If enable.detailed.heartbeat.response
is set to
false
, the default value, and the PingAccess instance is running, the endpoint returns
an HTTP 200
status and the text OK.
If enable.detailed.heartbeat.response
is set to
true
and the PingAccess
instance is running, a configurable status with additional details is returned. The
response output format is an Apache Velocity template defined in
<PA_HOME>/conf/template/heartbeat.page.json.
You can modify this template to suit your needs. The following values are
available.
The default content type for the output is application/json.
However, you can specify a content type header using the
$monitor.setContentType()
line in the template.
If you update the enable.detailed.heartbeat.response
value, you must
restart PingAccess for the new value to take
effect.
Calls to this endpoint can be logged in the audit log. You can enable heartbeat call
logging using the /httpConfig/monitoring
administrative endpoint.
For more information, see Administrative API endpoints.