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
}

Changes

Changed in 19 of the 73 revisions of this API.51492

Jul 28, 20269a6250881fa745See the full diff
- ▲
  added the new required request property general
  new-required-request-property
- ▲
  added the new required request property logger
  new-required-request-property
- ▲
  added the new required request property proxyServer
  new-required-request-property
- ▲
  added the new required request property webServer
  new-required-request-property
- ●
  removed the request property logParameters
  request-property-removed
- ●
  removed the request property name
  request-property-removed
- ●
  removed the request property port
  request-property-removed
- ●
  removed the request property proxyEnabled
  request-property-removed
- ●
  removed the request property proxyPort
  request-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026ea1c80cb9c6954See the full diff
- ▲
  added the new required request property logParameters
  new-required-request-property
- ▲
  added the new required request property name
  new-required-request-property
- ▲
  added the new required request property port
  new-required-request-property
- ▲
  added the new required request property proxyEnabled
  new-required-request-property
- ▲
  added the new required request property proxyPort
  new-required-request-property
- ●
  removed the request property general
  request-property-removed
- ●
  removed the request property logger
  request-property-removed
- ●
  removed the request property proxyServer
  request-property-removed
- ●
  removed the request property webServer
  request-property-removed
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026972e3d3a3300410See the full diff
- ▲
  added the new required request property general
  new-required-request-property
- ▲
  added the new required request property logger
  new-required-request-property
- ▲
  added the new required request property proxyServer
  new-required-request-property
- ▲
  added the new required request property webServer
  new-required-request-property
- ●
  removed the request property forwardProxyPassword
  request-property-removed
- ●
  removed the request property forwardProxyUrl
  request-property-removed
- ●
  removed the request property forwardProxyUsername
  request-property-removed
- ●
  removed the request property logParameters
  request-property-removed
- ●
  removed the request property name
  request-property-removed
- ●
  removed the request property port
  request-property-removed
- ●
  removed the request property proxyEnabled
  request-property-removed
- ●
  removed the request property proxyPassword
  request-property-removed
- ●
  removed the request property proxyPort
  request-property-removed
- ●
  removed the request property proxyUsername
  request-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 20, 20266a232346b1586See the full diff
- ▲
  added the new required request property forwardProxyPassword
  new-required-request-property
- ▲
  added the new required request property forwardProxyUrl
  new-required-request-property
- ▲
  added the new required request property forwardProxyUsername
  new-required-request-property
- ▲
  added the new required request property logParameters/syslog
  new-required-request-property
- ▲
  added the new required request property proxyPassword
  new-required-request-property
- ▲
  added the new required request property proxyUsername
  new-required-request-property
Jul 15, 202657cbe043ec5a6See the full diff
- ●
  removed the request property forwardProxyPassword
  request-property-removed
- ●
  removed the request property forwardProxyUrl
  request-property-removed
- ●
  removed the request property forwardProxyUsername
  request-property-removed
- ●
  removed the request property logParameters/syslog
  request-property-removed
- ●
  removed the request property proxyPassword
  request-property-removed
- ●
  removed the request property proxyUsername
  request-property-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 6, 20264c50d4a73f666See the full diff
- ▲
  added the new required request property forwardProxyPassword
  new-required-request-property
- ▲
  added the new required request property forwardProxyUrl
  new-required-request-property
- ▲
  added the new required request property forwardProxyUsername
  new-required-request-property
- ▲
  added the new required request property logParameters/syslog
  new-required-request-property
- ▲
  added the new required request property proxyPassword
  new-required-request-property
- ▲
  added the new required request property proxyUsername
  new-required-request-property
Jul 3, 2026a460443e789e6See the full diff
- ●
  removed the request property forwardProxyPassword
  request-property-removed
- ●
  removed the request property forwardProxyUrl
  request-property-removed
- ●
  removed the request property forwardProxyUsername
  request-property-removed
- ●
  removed the request property logParameters/syslog
  request-property-removed
- ●
  removed the request property proxyPassword
  request-property-removed
- ●
  removed the request property proxyUsername
  request-property-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026ea736a81a9316See the full diff
- ▲
  added the new required request property forwardProxyPassword
  new-required-request-property
- ▲
  added the new required request property forwardProxyUrl
  new-required-request-property
- ▲
  added the new required request property forwardProxyUsername
  new-required-request-property
- ▲
  added the new required request property logParameters/syslog
  new-required-request-property
- ▲
  added the new required request property proxyPassword
  new-required-request-property
- ▲
  added the new required request property proxyUsername
  new-required-request-property
Jun 24, 20262c78cb2da6476See the full diff
- ●
  removed the request property forwardProxyPassword
  request-property-removed
- ●
  removed the request property forwardProxyUrl
  request-property-removed
- ●
  removed the request property forwardProxyUsername
  request-property-removed
- ●
  removed the request property logParameters/syslog
  request-property-removed
- ●
  removed the request property proxyPassword
  request-property-removed
- ●
  removed the request property proxyUsername
  request-property-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 22, 2026748932ded1276See the full diff
- ▲
  added the new required request property forwardProxyPassword
  new-required-request-property
- ▲
  added the new required request property forwardProxyUrl
  new-required-request-property
- ▲
  added the new required request property forwardProxyUsername
  new-required-request-property
- ▲
  added the new required request property logParameters/syslog
  new-required-request-property
- ▲
  added the new required request property proxyPassword
  new-required-request-property
- ▲
  added the new required request property proxyUsername
  new-required-request-property

Full history (19 revisions)