Engine

Retrieve engine configuration

Returns the current configuration settings of the OIBus engine

get/api/engine

Response

The engine settings

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

versionstring required

The version of the engine.

launcherVersionstring required

The version of the launcher.

Example response

{
  "id": "entity123",
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "2023-10-31T12:34:56.789Z",
  "version": "3.7.0",
  "launcherVersion": "3.7.0",
  "general": {
    "name": "OIBus OT"
  },
  "webServer": {
    "authTokenDuration": "7d",
    "port": 2223
  },
  "logger": {
    "syslog": {
      "protocol": "udp4",
      "port": 514,
      "host": "syslog.example.com"
    },
    "oia": {
      "interval": 60
    },
    "loki": {
      "password": "pass",
      "username": "user",
      "address": "http://loki:3100",
      "interval": 60
    },
    "database": {
      "maxNumberOfLogs": 10000
    },
    "file": {
      "numberOfFiles": 5,
      "maxFileSize": 10485760
    }
  }
}

Changes

Changed in 25 of the 73 revisions of this API.611273

Jul 28, 20269a6250881fa754See the full diff
- ▲
  removed the required property logParameters from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property port from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyEnabled from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyPort from the response with the 200 status
  response-required-property-removed
- ○
  added the required property general to the response with the 200 status
  response-required-property-added
- ○
  added the required property logger to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyServer to the response with the 200 status
  response-required-property-added
- ○
  added the required property webServer to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026ea1c80cb9c6945See the full diff
- ▲
  removed the required property general from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property logger from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyServer from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property webServer from the response with the 200 status
  response-required-property-removed
- ○
  added the required property logParameters to the response with the 200 status
  response-required-property-added
- ○
  added the required property name to the response with the 200 status
  response-required-property-added
- ○
  added the required property port to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyEnabled to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyPort to the response with the 200 status
  response-required-property-added
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026972e3d3a3300104See the full diff
- ▲
  removed the required property forwardProxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUrl from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUsername from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property logParameters from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property port from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyEnabled from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyPort from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyUsername from the response with the 200 status
  response-required-property-removed
- ○
  added the required property general to the response with the 200 status
  response-required-property-added
- ○
  added the required property logger to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyServer to the response with the 200 status
  response-required-property-added
- ○
  added the required property webServer to the response with the 200 status
  response-required-property-added
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 required property forwardProxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUrl to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUsername to the response with the 200 status
  response-required-property-added
- ○
  added the required property logParameters/syslog to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyUsername to the response with the 200 status
  response-required-property-added
Jul 15, 202657cbe043ec5a6See the full diff
- ▲
  removed the required property forwardProxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUrl from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUsername from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property logParameters/syslog from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyUsername from the response with the 200 status
  response-required-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 required property forwardProxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUrl to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUsername to the response with the 200 status
  response-required-property-added
- ○
  added the required property logParameters/syslog to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyUsername to the response with the 200 status
  response-required-property-added
Jul 3, 2026a460443e789e6See the full diff
- ▲
  removed the required property forwardProxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUrl from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUsername from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property logParameters/syslog from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyUsername from the response with the 200 status
  response-required-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 required property forwardProxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUrl to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUsername to the response with the 200 status
  response-required-property-added
- ○
  added the required property logParameters/syslog to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyUsername to the response with the 200 status
  response-required-property-added
Jun 24, 20262c78cb2da6476See the full diff
- ▲
  removed the required property forwardProxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUrl from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property forwardProxyUsername from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property logParameters/syslog from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyPassword from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property proxyUsername from the response with the 200 status
  response-required-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 required property forwardProxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUrl to the response with the 200 status
  response-required-property-added
- ○
  added the required property forwardProxyUsername to the response with the 200 status
  response-required-property-added
- ○
  added the required property logParameters/syslog to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyPassword to the response with the 200 status
  response-required-property-added
- ○
  added the required property proxyUsername to the response with the 200 status
  response-required-property-added

Full history (25 revisions)