Sign in
Settings

Install a release and restart the server.

Changed on

Returns as soon as the attempt is accepted: the download and swap run in the background and the process then exits so its supervisor restarts it on the new binary. Poll GET /settings/update for progress — after the restart, last_attempt carries the outcome.

post/settings/update

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/settings/update
  • Auth: HTTP bearer

Request body

versionstring nullable

Release tag to install (e.g. v0.2.0). Omit to take the newest release on the channel this install already tracks.

Response

Update accepted; the server will restart

current_versionstring required

Version the server is running as it accepts this request.

estimated_restart_secsinteger required

How long to allow for the server to come back before treating the restart as failed. 0 when nothing restarts.

messagestring required
restart_mode'automatic' | 'manual' required

What happens to the running process once the new binary is in place.

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status