---
title: "Update engine configuration"
method: PUT
path: "/api/engine"
tags: ["Engine"]
---

# Update engine configuration

`PUT /api/engine`

Updates the configuration settings of the OIBus engine

## Request body

- EngineSettingsCommandDTO — Engine settings command Data Transfer Object. Used as the request body for updating engine settings.
  - `general` EngineNameCommandDTO, required — Engine name command Data Transfer Object. Used as the request body for updating only the engine name.
    - `name` string, required — The name of the engine.
  - `webServer` EngineWebServerCommandDTO, required — Engine web server command Data Transfer Object. Used as the request body for updating only the web server port and authentication token duration.
    - `port` number, double, required — The port on which the engine listens.
    - `authTokenDuration` '1h' | '1d' | '6h' | '3d' | '7d' | '14d' | '30d', required — Type representing an allowed authentication token duration.
  - `proxyServer` EngineProxyCommandDTO, required — Engine proxy command Data Transfer Object. Used as the request body for updating only the proxy settings.
    - `enabled` boolean, required — Whether the proxy is enabled.
    - `port` number, double, nullable — The port for the proxy, if enabled.
    - `username` string, nullable — The username for proxy server authentication.
    - `password` string, nullable — The password for proxy server authentication.
    - `forward` object — Upstream forward proxy settings.
      - `password` string, nullable — The password for upstream proxy authentication.
      - `username` string, nullable — The username for upstream proxy authentication.
      - `url` string, nullable — The URL of the upstream proxy to forward requests through.
      - `enabled` boolean, required — Whether forwarding to an upstream proxy is enabled.
  - `logger` EngineLoggerCommandDTO, required — Engine logger command Data Transfer Object. Used as the request body for updating only the logging parameters. The log category objects are top-level (no wrapper key).
    - `console` object, required — Console logging configuration.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `file` object, required — File logging configuration.
      - `numberOfFiles` number, double — The number of log files to keep.
      - `maxFileSize` number, double — The maximum size of a log file in bytes.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `database` object, required — Database logging configuration.
      - `maxNumberOfLogs` number, double — The maximum number of logs to keep in the database.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `loki` object, required — Loki logging configuration.
      - `password` string — The password for Loki authentication.
      - `username` string — The username for Loki authentication.
      - `address` string — The address of the Loki server.
      - `interval` number, double — The interval in seconds for sending logs to Loki.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `oia` object, required — OIA logging configuration.
      - `interval` number, double — The interval in seconds for sending logs to OIA.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `syslog` object, required — Syslog logging configuration.
      - `protocol` 'udp4' | 'tcp' — The transport protocol.
      - `port` number, double — The port of the syslog server.
      - `host` string — The hostname or IP of the syslog server. Empty string disables the transport.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.

## Response `200`

Engine settings updated successfully

- EngineSettingsUpdateResultDTO — Engine settings update result Data Transfer Object. Returned after updating engine settings to indicate if a redirect is needed.
  - `needsRedirect` boolean, required — Whether the client needs to redirect due to a port change.
  - `newPort` number, double, nullable, required — The new port to redirect to, if applicable.

---

[API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/versions/743d1b62f042/schema)