Sign in
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.

creationDatestring

Represents an instant in time as an ISO 8601 string.

lastEditInstantstring

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the engine.

portnumber double required

The port on which the engine listens.

versionstring required

The version of the engine.

launcherVersionstring required

The version of the launcher.

proxyEnabledboolean required

Whether the proxy is enabled.

proxyPortnumber double nullable required

The port for the proxy, if enabled.

Example response

{
  "id": "entity123",
  "creationDate": "2023-10-31T12:34:56.789Z",
  "lastEditInstant": "2023-10-31T12:34:56.789Z",
  "name": "OIBus OT",
  "port": 2223,
  "version": "3.7.0",
  "launcherVersion": "3.7.0",
  "logParameters": {
    "oia": {
      "interval": 60
    },
    "loki": {
      "password": "pass",
      "username": "user",
      "address": "http://loki:3100",
      "interval": 60
    },
    "database": {
      "maxNumberOfLogs": 10000
    },
    "file": {
      "numberOfFiles": 5,
      "maxFileSize": 10485760
    }
  }
}

Changes