Deploy server configuration

Use this endpoint to deploy the provided INUBIT server configuration to the corresponding INUBIT system.

Request

To deploy the server configuration, send a PUT or POST request to the /configurations endpoint.

URL: /configurations

Method: PUT or POST

Authorization: required (user with role System Administrator)

HTTP Request Example

PUT /ibis/rest/configurations HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: localhost:8080

Request Body

The request body must contain a JSON object with the server configuration.

Request Body Example

{
  "ServerConfiguration": {
    "GUIThreadsCount": 10,
    "TracingMaxBackupIndex": 2,
    "PluginUpdateAllowed": false,
    "UserInitialPassword": false,
    "NotifyWorkflow": "",
    "ToolsetUpdateAllowed": true,
    "TracingMaxFileSize": "20MB",
    "ProxyExceptions": "localhost|127.0.0.1"
  }
}

For a detailed list of all server configuration properties, refer to the GET server configuration request.

Response

If the request is successful, the server returns an HTTP 200 OK status code and a confirmation message.

HTTP Response Example

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

{
  "responsedata":
    [
      {
        "Total properties": 8
      },
      {
        "Deployed properties count": 8
      },
      {
        "Deployed properties": [
          "GUIThreadsCount",
          "TracingMaxBackupIndex",
          "PluginUpdateAllowed",
          "UserInitialPassword",
          "NotifyWorkflow",
          "ToolsetUpdateAllowed",
          "TracingMaxFileSize",
          "ProxyExceptions"
        ]
      }
    ]
}

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"
}