Health Check

Check that the services of the device are running

Each service exposes a health check that answers as long as the service is up. The endpoints need no token, so they can be polled by monitoring systems. A non-200 status or a connection error means the service is down or restarting.

API

Service	Method and path
Centralised Server	`GET /api/health_check`
Traffic analysis service	`GET /api/ftng/health_check`
Data queries service	`GET /api/chf/health_check`
Hardware controller service	`GET /api/system/health_check`

Common properties
- Minimum user role: none (no token required)
- Response on success (200 OK):
```
{
    "message": "Success",
    "data": {
        "time": 1790676630,
        "uptime": 1659,
        "pid": 1025,
        "commit_id": "04cb8b3"
    }
}
```
  - time - current time of the device, epoch seconds
  - uptime - seconds since the service was started
  - pid - process id of the service
  - commit_id - short git commit hash of the running service build
- Response on failure (500 Internal Server Error): {"message": "Failed to redirect request <path>: <reason>", "data": null} when the proxied service cannot be reached (the three proxied endpoints only)

Back to Index