Get readiness status

Use this resource to check if the Process Engine is ready to process requests. This endpoint is commonly used for health checks by load balancers or monitoring systems. The readiness status can be influenced by the maintenance mode or can be set manually.

The overall status of the endpoint is determined by a combination of the manually set status and the server’s maintenance mode. The following table shows the resulting overall status for each combination.

Manual status Maintenance mode Overall Status

Manual status	Maintenance mode	Overall Status
— (not set)	OFF	`READY`
— (not set)	ON	`NOT READY`
`READY`	OFF	`READY`
`READY`	ON	`NOT READY`
`NOT READY`	OFF	`NOT READY`
`NOT READY`	ON	`NOT READY`

— (not set)

OFF

READY

— (not set)

NOT READY

READY

OFF

READY

NOT READY

OFF

NOT READY

If the overall status is READY, the endpoint returns an HTTP status 200 OK. Otherwise, it returns an HTTP status 503 Service Unavailable.

Request

To check the readiness status, send a GET request to the /ready endpoint.

URL: /ready

Method: GET

Authorization: none

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

Request Parameters

This request does not have any parameters.

Response

If the service is ready, you will receive a 200 OK response with the following content.

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

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

Errors

This request might return one of the following error codes:

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): The server returns this error if the readiness status is NOT READY. This indicates that the service is currently not able to handle requests.