Change readiness status

Use this resource to manually set the readiness status of the Process Engine to READY or NOT READY. The final status also depends on the current maintenance mode activity. If the maintenance mode is active, the status is always NOT READY. If the maintenance mode is inactive, the status corresponds to the manually set status. When the status is READY, the endpoint returns HTTP status 200. When the status is NOT READY, the endpoint returns HTTP status 500.

Request

To change the readiness status, send a POST request to the endpoint defined below.

URL: /ready/{status}

Method: POST

Authorization: required (user with role System Administrator)

POST /ibis/rest/ready/off HTTP/1.1
Accept: application/json
Host: localhost:8080

Path Parameters

The following table lists the parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`status`	Enter the desired readiness status of the Process Engine.	yes	`on` (READY) or `off` (NOT READY)

status

Enter the desired readiness status of the Process Engine.

yes

on (READY) or off (NOT READY)

Response

The response indicates the result of the operation.

HTTP/1.1 503 Service Unavailable
Content-Type: application/json

{
  "status": "NOT READY",
  "message": "No Service."
}

Errors

This request might return one of the following error codes:

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

{
    "statusCode": 401,
    "message": "Unauthorized access",
    "path": "/rest/<endpoint>",
    "timestamp": "2025-06-07T14:21:11.781"
}

Resource Not Found (404): The 404 (Not Found) status code indicates that the requested endpoint or resource is unavailable or does not exist on the server.
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.

{
  "statusCode": 500,
  "message": "Internal Server Error",
  "path": "/rest/<endpoint>",
  "timestamp": "2025-08-06T12:55:31.862"
}

Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.

{
  "statusCode": 503,
  "message": "Service Unavailable",
  "path": "/rest/<endpoint>",
  "timestamp": "2025-08-06T12:58:06.688"
}