v70

latestOpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-031426201.0 MB

Engine

Update engine configuration

Updates the configuration settings of the OIBus engine

put/api/engine

Request body

Example request

{
  "general": {
    "name": "OIBus OT"
  },
  "webServer": {
    "port": 8080,
    "authTokenDuration": "7d"
  },
  "logger": {
    "file": {
      "numberOfFiles": 5,
      "maxFileSize": 10485760
    },
    "database": {
      "maxNumberOfLogs": 10000
    },
    "loki": {
      "password": "pass",
      "username": "user",
      "address": "http://loki:3100",
      "interval": 60
    },
    "oia": {
      "interval": 60
    },
    "syslog": {
      "protocol": "udp4",
      "port": 514,
      "host": "syslog.example.com"
    }
  }
}

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
}