Engine

Update engine configuration

Changed on

Updates the configuration settings of the OIBus engine

put/api/engine

Request

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

Request body

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 request

{
  "general": {
    "name": "OIBus OT"
  },
  "webServer": {
    "port": 8080,
    "authTokenDuration": "7d",
    "https": {
      "enabled": true,
      "certificateSource": "store",
      "certificateId": "certificateId",
      "certificatePath": "/etc/oibus/oibus.crt",
      "privateKeyPath": "/etc/oibus/oibus.key"
    }
  },
  "logger": {
    "auditRetentionDuration": 90,
    "file": {
      "numberOfFiles": 5,
      "maxFileSize": 10485760
    },
    "database": {
      "maxNumberOfLogs": 10000
    },
    "loki": {
      "password": "pass",
      "username": "user",
      "address": "http://loki:3100",
      "interval": 60
    },
    "oia": {
      "interval": 60
    },
    "syslog": {
      "protocol": "udp4",
      "port": 514,
      "host": "syslog.example.com"
    }
  },
  "auditRetentionDuration": 90
}

Response

Engine settings updated successfully

needsRedirectboolean required

Whether the client needs to redirect due to a port or protocol change.

newPortnumber double nullable required

The port to redirect to, if applicable.

newProtocol'http' | 'https' required

Type representing a web server protocol.

Example response

{
  "needsRedirect": true,
  "newPort": 3333,
  "newProtocol": "https"
}

Changes

  • 0df3f625a5c2Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property /

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • breaking

      the request property // became required

    • info

      added the new optional request property /

    • info

      added the required property to the response with the status

  • 21b34a490fa3Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      the request property // became optional

    • info

      the request property // became optional

    • info

      the request property // became optional

    • info

      the request property // became optional

    • info

      the request property // became optional

    • info

      the request property // became optional

    • info

      the request property // became optional