Introduction

Edit online

The Upgrade System Software APIs are used to upgrade device software across the network.

These API methods follow a best practices workflow, similar to the Manager UI upgrade functionality. Upgrade APIs accept only an array of device UUIDs and do not support individual pool UUIDs.

WARNING: A current backup of the Manager database is strongly advised before performing an upgrade. For details, see Backup system in the “Administration” section.

Note: Upgrade System Software APIs are rate-limited (with the exception of the viewUpgradeStatus API method). Specifically, to ensure system health and prevent unwanted results arising from conflicting data input, the Manager application will only process one upgrade request at a time. Responses will include two headers: 'X-RateLimit-Limit' and 'X-RateLimit-Remaining'.

Note: Depending on upgrade version, new End-User License Agreement (EULA) acceptance may be required. If required, EULA acceptance must be performed through the Manager UI prior to upgrading devices.