The Health API
Siren Investigate exposes an API to monitor the health of the application process and operating system. It is available via the HTTP GET method at /api/health?pretty=true
.
It returns an HTTP status code of 200
when the application process is running.
The response payload is a JSON containing details about the process and operating system load.
Example response:
{
"secSinceLast": 5.001,
"ops": {
"proc": {
"eventLoopDelay": 0,
"heapUsed": 0,
"rss": 0,
"uptime": 704.991883051
},
"os": {
"load": [
3.01513671875,
3.38037109375,
3.830078125
]
}
}
}
By default, the health API endpoint requires authentication.
To disable authentication for this endpoint, add the following to investigate.yml
:
health.allowAnonymous: true