HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Cancel Scheduled Upgrade at MSP Level

Cancel a scheduled firmware upgrade for the specific type of devices, for all the tenants of an MSP customer.

To cancel scheduled upgrade for certain type of devices, 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.

To exclude groups from canceling the scheduled upgrade, please specify exclude_groups with a list of groups in the body.

To exclude tenants from canceling the scheduled upgrade, please specify exclude_customers with a list of tenant IDs in the body.

This API will be deprecated soon. Please use API /firmware/v2/msp/upgrade/cancel to cancel scheduled upgrade for all the tenants.

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 device_type to cancel scheduled upgrade of devices.

string

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

string

List of groups to be excluded while canceling scheduled upgrade, e.g. "["TestGroup1", "TestGroup2"]"

string

List of customer IDs to be excluded while canceling scheduled upgrade, e.g. "["111111", "111112"]"

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