Engine

Update web server settings

Changed on

Updates only the web server port

put/api/engine/web-server

Request

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

Request body

portnumber 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.

Example request

{
  "port": 8080,
  "authTokenDuration": "7d",
  "https": {
    "enabled": true,
    "certificateSource": "store",
    "certificateId": "certificateId",
    "certificatePath": "/etc/oibus/oibus.crt",
    "privateKeyPath": "/etc/oibus/oibus.key"
  }
}

Response

Engine web server 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
    • 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