Skip to main content

Monitor service availability with the health endpoint

The platform exposes a health endpoint that reports the status of the admin database, the platform application server, and every registered repository database. Poll it from your monitoring tools to catch problems early.

Endpoint​

Make an HTTP GET request to:

https://<your-service-url>/Health

The path is case-sensitive — capitalize the H in /Health.

Response​

The endpoint returns JSON with an overall healthSummary plus the status of the platform, the admin database, and each registered repository database. A component reports UP when it's available and DOWN when it isn't (INSTALLING appears while a component is still being set up).

{
  "healthSummary": {
    "admindatabase": "UP",
    "platform": "UP",
    "repositories": "UP"
  },
  "platformHealthStatus": { "healthIndicator": "UP" },
  "adminHealthStatus": { "healthIndicator": "UP" },
  "repositoryHealthStatus": {
    "11111111-1111-1111-1111-111111111111": { "healthIndicator": "UP" },
    "22222222-2222-2222-2222-222222222222": { "healthIndicator": "UP" }
  }
}
FieldReports
healthSummaryThe overall health of the system components.
platformHealthStatusThe core platform (application server).
adminHealthStatusThe admin database.
repositoryHealthStatusEach registered repository database, keyed by its UUID.

Monitor the endpoint​

  • Manually — open the URL in a browser, or run curl -X GET https://<your-service-url>/Health.
  • Automatically — poll /Health from a tool such as Prometheus, Datadog, Nagios, or AWS CloudWatch, and alert when any value is DOWN.

Troubleshooting​

healthSummary valuePossible causeWhat to check
"platform": "DOWN"The service is unavailable or failing.Check the server logs, restart the service, and verify the database connections.
"admindatabase": "DOWN"The admin database connection failed.Make sure the database is running and reachable.
"repositories": "DOWN"One or more repository databases are unavailable.Identify the affected repository, check its database, and review the server logs (for example, a failed upgrade).

For more help, contact your system administrator or the iGrafx support portal.