Site Admin 26.3
Site Admin Installation Guide

# JSON Health Check API

Site Admin includes a JSON health check test, which you can use in conjunction with external monitoring systems such as Nagios to check the status of the Site Admin back-end components. Authentication is not required to use this feature.

To run a health check

- In your Web browser, go to `http://host:port/api/external/health/healthCheck.json`, where `host` and `port` are the host name or IP address and port details of your Site Admin installation.

- The output indicates the health of each component in the form of `componentName` and `state` pairs, and also shows the number of warnings or errors. For example:

  `{"componentHealth":[{"componentName":"DOC.TRACKING","state":"DISABLED"},{"componentName":"COMMUNITY","state":"UP"},{"componentName":"POSTGRES","state":"UP"},{"componentName":"COORDINATOR","state":"UP"}],"numWarnings":0,"numErrors":0}`

Copyright 2015-2026 Open Text
Version 26.3 | Last updated July 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Site Admin 26.3

Topic Title: JSON Health Check API