Engine

Retrieve engine configuration

Changed on

Returns the current configuration settings of the OIBus engine

get/api/engine

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/engine
  • Auth: none required

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.

auditRetentionDurationnumber double nullable required

Number of days audit log entries are kept before being pruned. null (or 0) means audit logs are kept forever.

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",
  "auditRetentionDuration": 90,
  "general": {
    "name": "OIBus OT"
  },
  "webServer": {
    "https": {
      "enabled": true,
      "certificateSource": "store",
      "certificateId": "certificateId",
      "certificatePath": "/etc/oibus/oibus.crt",
      "privateKeyPath": "/etc/oibus/oibus.key"
    },
    "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

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property / from the response with the status