v51

OpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-01133591927.1 KB

Engine

Update engine configuration

Updates the configuration settings of the OIBus engine

put/api/engine

Request body

namestring required

The name of the engine.

portnumber double required

The port on which the engine listens.

proxyEnabledboolean required

Whether the proxy is enabled.

proxyPortnumber double nullable required

The port for the proxy, if enabled.

Example request

{
  "name": "OIBus OT",
  "port": 8080,
  "logParameters": {
    "oia": {
      "interval": 60
    },
    "loki": {
      "password": "pass",
      "username": "user",
      "address": "http://loki:3100",
      "interval": 60
    },
    "database": {
      "maxNumberOfLogs": 10000
    },
    "file": {
      "numberOfFiles": 5,
      "maxFileSize": 10485760
    }
  }
}

Response

Engine settings updated successfully

needsRedirectboolean required

Whether the client needs to redirect due to a port change.

newPortnumber double nullable required

The new port to redirect to, if applicable.

Example response

{
  "needsRedirect": true,
  "newPort": 3333
}