- API Reference
- Box API
- 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.
/v2/updater_new_versionQuery parameters
Target version (v21.3.4 or 21.3.4); default latest.
1 or true writes a verbose installer log.
Same as debug.
Responses
Update state.
scheduled, updating, or false with msg.
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
Version not found. Please contact support | The requested version does not exist for this box. | Use a version from /v2/release_info. |
release info unavailable | The release server could not be reached to check the version. | Retry later. |
Requested version not found | The version check failed. | Check the version string and retry. |