HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Firmware Upgrade

Upgrade firmware version for a device or for a whole group of devices under a device type, with additional filter of model.

To initiate upgrade for certain type of devices of specific group, specify device_type as one of "IAP" for swarm, "MAS" for MAS switches, "HP" for aruba switches, "CX" for CX switches, "CONTROLLER" for controllers respectively, and group name.

To upgrade a device, you can specify swarm_id to upgrade a specific swarm or serial to upgrade a specific device.

To upgrade a specific model of Aruba switches at group level, please use model in request body.

Possible error_codes for the error responses are

  1. 0001 - General Error.
  2. 0003 - Validation Error. Unsupported query combination
  3. 0004 - Validation Error. Invalid value for a query parameter
  4. 0005 - Validation Error. Missing required parameter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Initiate firmware upgrade for entire group or for a device.

int32

Firmware upgrade will be scheduled at, firmware_scheduled_at - current time. firmware_scheduled_at is epoch in seconds and default value is current time

string

Swarm ID

string

Serial of device

string

Specify Group Name to initiate upgrade for whole group.

string

Specify one of "IAP/MAS/HP/CX/CONTROLLER"

string

Specify firmware version to which you want device to upgrade. If you do not specify this field then firmware upgrade initiated with recommended firmware version

boolean

Use True for auto reboot after successful firmware download. Default value is False. Applicable only on MAS, aruba switches, CX switches, and controller since IAP reboots automatically after firmware download.

string

To initiate upgrade at group level for specific model family. Applicable only for Aruba switches.

boolean

Use True for forcing the upgrade of a gateway which is part of a cluster

Responses

401

Unauthorized

403

Forbidden

404

Not found

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json