STstudio-saelix
Health

Trigger self-update

Changed on

Instructs this Sencho instance to pull the update image and recreate its own container. An optional release version in the request body drives semver repinning; floating tags are pulled without rewriting the compose file. Digest and unresolved pins are rejected with 409 before any pull runs. Returns 202 immediately; the actual update happens asynchronously after the response is sent. Requires the instance to be deployed via Docker Compose with the Docker socket mounted.

post/api/system/update

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/system/update
  • Auth
    HTTP bearer

Request body

targetVersionstring

Release version to update to (valid semver).

Response

Update initiated.

messagestring

Example response

{
  "message": "Update initiated. The server will restart shortly."
}

Changes

  • 398bd5a72b2bRevision changes
    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • d58cf9d6195bRevision changes
    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status