Sign in
Engine

Retrieve OIBus information

Returns version and system information about the OIBus instance

get/api/engine/info

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

Changed in 3 of the 73 revisions of this API.24

  • 9a6250881fa72See the full diff
    • ○

      added the required property ignoreIpFilters to the response with the 200 status

      response-required-property-added

    • ○

      added the required property ignoreRemoteUpdate 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

  • ea1c80cb9c692See the full diff
    • ▲

      removed the required property ignoreIpFilters from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property ignoreRemoteUpdate from the response with the 200 status

      response-required-property-removed

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c492d4689a82See the full diff
    • ○

      added the required property ignoreIpFilters to the response with the 200 status

      response-required-property-added

    • ○

      added the required property ignoreRemoteUpdate to the response with the 200 status

      response-required-property-added