---
title: "Retrieve engine configuration"
method: GET
path: "/api/engine"
tags: ["Engine"]
---

# Retrieve engine configuration

`GET /api/engine`

Returns the current configuration settings of the OIBus engine

## Response `200`

The engine settings

- EngineSettingsDTO — Engine settings Data Transfer Object. Represents the configuration settings for the engine.
  - `id` string, required — The unique identifier of the entity.
  - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
  - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
  - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
  - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string.
  - `name` string, required — The name of the engine.
  - `port` number, double, required — The port on which the engine listens.
  - `version` string, required — The version of the engine.
  - `launcherVersion` string, required — The version of the launcher.
  - `proxyEnabled` boolean, required — Whether the proxy is enabled.
  - `proxyPort` number, double, nullable, required — The port for the proxy, if enabled.
  - `forwardProxyUrl` string, nullable, required — The URL of the upstream proxy to forward requests through.
  - `forwardProxyUsername` string, nullable, required — The username for upstream proxy authentication.
  - `forwardProxyPassword` string, nullable, required — The password for upstream proxy authentication.
  - `proxyUsername` string, nullable, required — The username clients must use to authenticate with this proxy server. Null means no authentication required.
  - `proxyPassword` string, nullable, required — The password clients must use to authenticate with this proxy server.
  - `logParameters` object, required — Logging parameters for different outputs.
    - `syslog` object, required — Syslog logging configuration.
      - `protocol` 'udp4' | 'tcp', required — The transport protocol.
      - `port` number, double, required — The port of the syslog server.
      - `host` string, required — 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.
    - `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.

## Changes

- **2026-07-20** `6a232346b158` — 6 info
  - added the required property `forwardProxyPassword` to the response with the `200` status
  - added the required property `forwardProxyUrl` to the response with the `200` status
  - added the required property `forwardProxyUsername` to the response with the `200` status
  - added the required property `logParameters/syslog` to the response with the `200` status
  - …2 more
- **2026-07-15** `57cbe043ec5a` — 6 breaking
  - removed the required property `forwardProxyPassword` from the response with the `200` status
  - removed the required property `forwardProxyUrl` from the response with the `200` status
  - removed the required property `forwardProxyUsername` from the response with the `200` status
  - removed the required property `logParameters/syslog` from the response with the `200` status
  - …2 more
- **2026-07-06** `4c50d4a73f66` — 6 info
  - added the required property `forwardProxyPassword` to the response with the `200` status
  - added the required property `forwardProxyUrl` to the response with the `200` status
  - added the required property `forwardProxyUsername` to the response with the `200` status
  - added the required property `logParameters/syslog` to the response with the `200` status
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/optimistiksas/apis/oibus-api/changes/api/engine/get.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/d3abecc48b97/schema)