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

The following table describes the parameters of the request body.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`ServerConfiguration`	Defines the server configuration details.	yes	Json object

ServerConfiguration

Defines the server configuration details.

yes

Json object

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.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

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): 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.