API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Software

Start updating the box software to the latest or a given version

Use this only to install new software. Despite being a GET, it downloads and runs the installer in the background; the panel and proxies restart when it finishes. With version the version is first checked against the release server and refused if not found. Returns scheduled when started, updating when an update is already running. Follow progress with /v2/updater_new_version_status.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: needs owner approval
  • startSoftwareUpdate
GET/v2/updater_new_version

Query parameters

versionstringoptional

Target version (v21.3.4 or 21.3.4); default latest.

debugstringoptional

1 or true writes a verbose installer log.

verbosestringoptional

Same as debug.

Responses

Update state.

statusstring | booleanoptional

scheduled, updating, or false with msg.

msgstringoptional

Errors returned in msg

msgMeaningWhat to do
Version not found. Please contact supportThe requested version does not exist for this box.Use a version from /v2/release_info.
release info unavailableThe release server could not be reached to check the version.Retry later.
Requested version not foundThe version check failed.Check the version string and retry.
Verified against XProxy v21.3.2 on Nov 17, 2026