Health API

Fetching Status

HTTP Method	GET
Endpoint	`/api/v1/health`

By sending a request to Fess at http://<Server Name>/api/v1/health, you can receive the server status of Fess in JSON format.

There are no request parameters that can be specified.

The following response is returned:

{
  "data": {
    "status": "green",
    "timed_out": false
  }
}

Each element is as follows:

Response Information
data	Parent element of search results.
status	System status. Returns `green` when normal, `yellow` when there are warnings, and `red` when there are errors.
timed_out	Whether a timeout occurred. Returns `false` if a response is returned within the specified time, `true` if it times out.

When the Health API fails, the following error response is returned:

Error Response
Status Code	Description
500 Internal Server Error	When an internal server error occurs