Check application health

Use this resource to retrieve status information about the internal server state. The response includes the following information:

  • Application status (OK or ERROR)

  • Maintenance mode (0 or 1)

  • Current timestamp

Regardless of the maintenance mode, this endpoint always responds successfully.

The response of this endpoint indicates that the Tomcat application server has started. It also indicates that the INUBIT application has been loaded successfully. It does not give any sign of possible problems within the INUBIT application.

Request

To check the health of the application, send a GET request to the endpoint defined below.

URL: /healthcheck

Method: GET

Authorization: none

GET /ibis/rest/healthcheck HTTP/1.1
Accept: application/json
Host: localhost:8080

Response

The response contains the current status of the application.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status":"OK",
  "maintenancemode":0,
  "timestamp":"Thu Jul 29 11:32:03 IST 2021"
}

Errors

This request does not return any specific errors.