Health API

This feature is available to all customers and does not require Incredibuild's Enterprise Plan.

This Health API can be integrated into your IT monitoring system.

You can use the Health API to check on the Incredibuild service status, license details, Coordinator service status, Active Directory status, and details on the backup Coordinators.

This endpoint does not require any authentication.

Request Endpoint

GET https://<coordinatorIP>:8000/health/api

Request Response

Example Response

{ "status": "Up",
  "details": {
    "license": {
      "serviceStatus": "Up",
      "expirationDate": 1780876800000,
      "contractEndDate": null,
      "tier": "Enterprise"},
    "coordinator": {
      "serviceStatus": "Up"},
    "activeDirectory": {
      "status": "N/A"},
    "azureActiveDirectory": {
      "status": "N/A"},
    "backupCoordinators": [
      { "buildNumber": "15442",
        "isSelected": true,
        "ip": "198.51.100.0",
        "hostName": "some_machine",
        "port": "31104",
        "status": "Up”}
    ]
  }
}