HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Add a new switch software upgrade process

post
https://example.com/api/switches/software/upgrades
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
required

Assertion that the client accepts the end user license agreement (EULA) for the software to be staged in the request. A value of false indicates the user does not accept the agreement, and the request will be denied.

Body Params

Software upgrade process details

string
enum
required

Type of upgrade. Sequenced or immediate upgrade.When sequenced upgrade is selected, returned groups will have sequenced order assigned, rather than the order originally specified by the user.

Allowed:
groups
array of objects
required
length ≥ 1

Switch software upgrade groups. Groups themselves are staged serially, but switches within each group may be staged serially or in parallel.

groups*
switches
array of objects
required
length ≥ 1

Switches and optional partition to be upgraded.If boot partition not specified, it defaults to the non-active (not currently booted) partition.

switches*
string
required

UUID of Switch to be rebooted.

string
enum
required

Indicates which boot partition to upgrade firmware from.Not specifying will result in usingthe non-active partition.

Allowed:
Responses

Updated over 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; version=1.0

Updated over 2 years ago