Get readiness status

This resource provides the current ready status of the Process Engine. The status of this endpoint can be changed manually.

The overall endpoint status is calculated by the manually set READY status and the maintenance mode:

Manual status

Maintenance mode

Overall Status

— (not set)

OFF

READY

— (not set)

NOT READY

READY

OFF

READY

NOT READY

OFF

NOT READY

Is the overall status READY the endpoint will return with HTTP status 200. Otherwise the endpoint will return with HTTP status 503.

Request

URL: /ready

Method: GET

Authorization: none

GET /ibis/rest/ready HTTP/1.1
Accept: */*
Host: localhost:8080

None

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

{
  "status": "READY",
  "message": "Ready to serve."
}

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): As long as the status of this endpoint is NOT READY it will return this error response.