HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Set Firmware Compliance Version for MSP customer

Set firmware compliance version for specific device_type, for an MSP customer so that all devices of all tenants for that device_type will upgrade to given compliance version or whenever the device connects to central then it will upgrade to compliance version automatically if the device is not on compliance version.
If you want to set firmware compliance for specific tenants then provide tenants in the body which is a list of tenant IDs.
Please 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.

This API does not allow to set unsupported version as firmware compliance. To set unsupported version as firmware compliance please provide "allow_unsupported_version" as True in the body of API.

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

Please specify firmware version and device_type.

string
required

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

string
required

Firmware compliance version for specific device_type.

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.

boolean

Use True to set unsupported version as firmware compliance version for specific device_type. Default is False.

int32

Firmware compliance will be schedule at, compliance_scheduled_at - current time. compliance_scheduled_at is epoch in seconds and default value is current time.

string

List of tenant IDs to set firmware compliance , e.g. "["111111", "111112"]"

Responses
200

Successful response

401

Unauthorized

403

Forbidden

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