---
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.
  - `name` string, required — The name of the engine.
  - `port` number, double, required — The port on which the engine listens.
  - `proxyEnabled` boolean, required — Whether the proxy is enabled.
  - `proxyPort` number, double, nullable, required — The port for the proxy, if enabled.
  - `logParameters` object, required — Logging parameters for different outputs.
    - `oia` object, required — OIA logging configuration.
      - `interval` number, double, required — The interval in seconds for sending logs to OIA.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `loki` object, required — Loki logging configuration.
      - `password` string, required — The password for Loki authentication.
      - `username` string, required — The username for Loki authentication.
      - `address` string, required — The address of the Loki server.
      - `interval` number, double, required — The interval in seconds for sending logs to Loki.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `database` object, required — Database logging configuration.
      - `maxNumberOfLogs` number, double, required — The maximum number of logs to keep in the database.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `file` object, required — File logging configuration.
      - `numberOfFiles` number, double, required — The number of log files to keep.
      - `maxFileSize` number, double, required — The maximum size of a log file in bytes.
      - `level` 'silent' | 'error' | 'warn' | 'info' | 'debug' | 'trace', required — Type representing a log level.
    - `console` object, required — Console logging configuration.
      - `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.

## Changes

- **2026-01-13** `fe06c6a14380` — 1 breaking, 1 info
  - removed the success response with the status `204`
  - added the success response with the status `200`
- **2026-01-06** `d8e7a58e006a` — 1 breaking, 1 info
  - removed the success response with the status `200`
  - added the success response with the status `204`

[Change history](https://skmtc.dev/optimistiksas/apis/oibus-api/changes/api/engine/put.md)

---

[API](https://skmtc.dev/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.dev/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/revisions/cdb5b7ea7199/schema)