Engine

Retrieve OIBus information

Changed on

Returns version and system information about the OIBus instance

get/api/engine/info

Request

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

Response

OIBus information including version, build, and system details

versionstring required

The version of OIBus.

launcherVersionstring required

The version of the launcher.

oibusNamestring required

The name of the OIBus instance.

oibusIdstring required

The ID of the OIBus instance.

dataDirectorystring required

The data directory for OIBus.

binaryDirectorystring required

The binary directory for OIBus.

processIdstring required

The process ID of the OIBus instance.

hostnamestring required

The hostname of the machine running OIBus.

operatingSystemstring required

The operating system of the machine.

architecturestring required

The architecture of the machine.

platformstring required

The platform of the machine.

ignoreIpFiltersboolean required

Whether IP filters are ignored (disabled) via the --ignoreIpFilters launch flag.

ignoreRemoteUpdateboolean required

Whether remote update is ignored (disabled) via the --ignoreRemoteUpdate launch flag.

Example response

{
  "version": "3.7.0",
  "launcherVersion": "3.7.0",
  "oibusName": "OIBus OT",
  "oibusId": "aBc12F",
  "dataDirectory": "/var/lib/oibus",
  "binaryDirectory": "/usr/lib/oibus",
  "processId": "12345",
  "hostname": "server1",
  "operatingSystem": "linux",
  "architecture": "x64",
  "platform": "ubuntu"
}

Changes

  • 87f398dc0b57Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • ea1c80cb9c69Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status