This is a cache of https://fess.codelibs.org/14.18/api/api-health.html. It is a snapshot of the page at 2024-11-22T00:14:27.860+0000.
Health API

Menu

Health API

Get Status

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

Request Parameters

There are no available request parameters.

Response

The response will be as follows:

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

The elements in the response are described as follows:

data The parent element of the response.
status The status of the response. “green” is returned for normal status.
timed_out The response result. “false” is returned if the response is received within the specified time.

Table: Response Information