upgradeOrgMultiSitesDevices

POST https://{{host}}/api/v1/orgs/:org_id/devices/upgrade

Body Parameters

NameTypeDescription
versionstringdefault is stable
enable_p2pbooleanwhether to allow local AP-to-AP FW upgrade
site_idsarray of stringssite’s which need to be upgraded
strategystringbig_bang(upgrade all at once), serial(one at a time), canary or rrm, default is big_bang
canary_phasesarray of intsphases for canary deployment, default is [1, 10, 50, 100]
max_failuresarray of intsnumber of failures allowed within a canary phase or serial rollout. Will be used if provided, else maxfailurepercentage will be used
max_failure_percentageintpercentage of failures allowed within a canary phase or serial rollout, default is 5
rrm_node_orderstringfringetocenter or centertofringe (default fringetocenter)
rrm_slow_rampbooleantrue will make rrm batch sizes slowly ramp up
start_timelongupgrade start time in epoch seconds, default is now
reboot_atlongreboot start time in epoch seconds, default is start_time
forcebooltrue will force upgrade when requested version is same as running version

Request Body

{"version"=>"3.1.5", "enable_p2p"=>false, "site_ids"=>["4ac1dcf4-9d8b-7211-65c4-057819f0862b", "d96e3952-53e8-4266-959a-45acd55f5114"], "models"=>["AP41"], "strategy"=>"canary", "canary_phases"=>[5, 25, 50, 100], "max_failures"=>[1, 1, 5], "max_failure_percentage"=>5, "start_time"=>1624399840, "force"=>true}

RESPONSES

status: OK

{"id":"f57096b9-0c2f-4df6-c77b-ae6ae87a3d43"}