Juniper Mist AI Utilities Upgrade API
API Calls used to manage device upgrades for a single device, at the site level or at the organization level.
Juniper Mist AI Utilities Upgrade API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Utilities Upgrade. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 29 operations across 21 paths, and defines 85 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
29 operations
21 paths
85 schemas
14 GET13 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Juniper Mist AI Utilities Upgrade API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…basicAuth— While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.csrfToken— This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…
Paths & Operations 29
Across 21 paths, the API surfaces 29 operations — 14 GET, 13 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Utilities Upgrade 29
API Calls used to manage device upgrades for a single device, at the site level or at the organization level.
GET
/api/v1/orgs/{org_id}/devices/upgrade
listOrgDeviceUpgrades
POST
/api/v1/orgs/{org_id}/devices/upgrade
upgradeOrgDevices
GET
/api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}
getOrgDeviceUpgrade
POST
/api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}/cancel
cancelOrgDeviceUpgrade
GET
/api/v1/orgs/{org_id}/devices/versions
listOrgAvailableDeviceVersions
POST
/api/v1/orgs/{org_id}/jsi/devices/{device_mac}/upgrade
upgradeOrgJsiDevice
GET
/api/v1/orgs/{org_id}/mxedges/upgrade
listOrgMxEdgeUpgrades
POST
/api/v1/orgs/{org_id}/mxedges/upgrade
upgradeOrgMxEdges
GET
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}
getOrgMxEdgeUpgrade
PUT
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}
updateOrgMxEdgeUpgrade
POST
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}/cancel
cancelOrgMxEdgeUpgrade
GET
/api/v1/orgs/{org_id}/ssr/upgrade
listOrgSsrUpgrades
POST
/api/v1/orgs/{org_id}/ssr/upgrade
upgradeOrgSsrs
GET
/api/v1/orgs/{org_id}/ssr/upgrade/{upgrade_id}/cancel
getOrgSsrUpgrade
POST
/api/v1/orgs/{org_id}/ssr/upgrade/{upgrade_id}/cancel
cancelOrgSsrUpgrade
GET
/api/v1/orgs/{org_id}/ssr/versions
listOrgAvailableSsrVersions
GET
/api/v1/sites/{site_id}/devices/upgrade
listSiteDeviceUpgrades
POST
/api/v1/sites/{site_id}/devices/upgrade
upgradeSiteDevices
GET
/api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}
getSiteDeviceUpgrade
POST
/api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}/cancel
cancelSiteDeviceUpgrade
GET
/api/v1/sites/{site_id}/devices/versions
listSiteAvailableDeviceVersions
POST
/api/v1/sites/{site_id}/devices/{device_id}/upgrade
upgradeDevice
GET
/api/v1/sites/{site_id}/mxedges/upgrade
listSiteMxEdgeUpgrades
POST
/api/v1/sites/{site_id}/mxedges/upgrade
upgradeSiteMxEdges
GET
/api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}
getSiteMxEdgeUpgrade
PUT
/api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}
updateSiteMxEdgeUpgrade
POST
/api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}/cancel
cancelSiteMxEdgeUpgrade
GET
/api/v1/sites/{site_id}/ssr/upgrade/{upgrade_id}
getSiteSsrUpgrade
POST
/api/v1/sites/{site_id}/ssr/{device_id}/upgrade
upgradeSsr
Schemas 85
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are upgrade_org_devices (24 properties), upgrade_site_devices (21 properties), response_site_device_upgrade (16 properties), response_site_device_upgrades_item (13 properties). Each schema is shown below with its type and property counts.
upgrade_devices_targets_downloading
array
List of devices MAC Addresses which are currently downloading the firmware
upgrade_org_devices_version
object
4 properties
response_site_device_upgrades_item
object
13 properties
1 required
strings
array
response_ssr_upgrade_status_targets
object
4 properties
4 required
upgrade_device_rrm_node_order
string
For APs only and if strategy==rrm. Used in rrm to determine whether to start upgrade from fringe or center AP’s. enum: centertofringe, fringetocenter
mxedge_upgrade_multi_mxedge_ids
array
List of mxedge IDs to upgrade. If not specified, it means all the org mxedges.
response_site_device_upgrade
object
16 properties
1 required
upgrade_org_devices
object
24 properties
device_version
array
upgrade_devices_targets_downloaded
array
List of devices MAC Addresses which have the firmware downloaded
upgrade_device_rules
array
Rules used to identify devices which will be selected for upgrade. Device will be selected as long as it satisfies any one rule Property key defines the type o…
timestamp
number
Epoch (seconds)
upgrade_device_canary_phases
array
Only if strategy==canary. Phases for canary deployment. Each phase represents percentage of devices that need to be upgraded in that phase. default is [1, 10,…
ssr_versions
array
upgrade_devices_targets_reboot_in_progress
array
List of devices MAC Addresses which are rebooting
upgrade_devices_targets
object
10 properties
response_mxedge_upgrade
object
6 properties
6 required
upgrade_site_devices
object
21 properties
upgrade_org_devices_upgrade
object
2 properties
upgrade_device_strategy
string
enum: bigbang (upgrade all at once), canary, rrm (APs only), serial (one at a time)
device_type
string
enum: ap, gateway, switch
response_http401
object
1 property
ssr_upgrade_multi_device_ids
array
List of 128T device IDs to upgrade
upgrade_org_devices_upgrade_infos
array
upgrade_org_devices_upgrade_info
object
4 properties
response_ssr_upgrade
object
7 properties
7 required
upgrade_org_devices_versions
array
upgrade_info_status
string
enum: error, inprogress, scheduled, starting, success
upgrade_org_devices_item_site_upgrades
array
upgrade_devices_targets_download_requested
array
List of devices MAC Addresses which cloud has requested to download firmware
device_upgrade
object
5 properties
1 required
upgrade_devices_targets_scheduled
array
List of devices MAC Addresses which cloud has scheduled an upgrade for
version_string
object
1 property
mxedge_upgrade_multi
object
9 properties
1 required
response_upgrade_org_devices
object
6 properties
upgrade_devices_plans
object
If strategy!=bigbang, a dictionary of phase number to devices part of that phase
upgrade_site_devices_counts
object
9 properties
upgrade_device_models
array
Models which will be selected for upgrade
ssr_version_channel
string
enum: stable, beta, alpha
upgrade_org_devices_item
object
2 properties
mxedge_upgrade_multi_allow_downgrades
object
Whether downgrade is allowed when running version is higher than expected version for each service
5 properties
response_site_device_upgrade_canary_phases
array
phases for canary deployment. Each phase represents percentage of devices that need to be upgraded in that phase.
mxedge_upgrade_response_counts
object
4 properties
4 required
upgrade_org_devices_download_strategy
string
enum: bigbang: download all at once, no orchestration serial: one at a time' canary: upgrade in phases
device_version_item
object
3 properties
2 required
response_ssr_upgrade_counts
object
4 properties
4 required
ssr_upgrade
object
4 properties
1 required
ssr_version
object
4 properties
2 required
response_ssr_upgrades
array
mxedge_upgrade_strategy
string
enum: bigbang: upgrade all at once, no orchestration serial: one at a time' canary: upgrade in phases
upgrade_devices_max_failure_percentage
integer
If strategy!=bigbang. percentage of failures allowed across the entire upgrade
upgrade_devices_targets_skipped
array
List of devices MAC Addresses which skipped upgrade since requested version was same as running version. Use force to always upgrade
response_device_upgrade
object
2 properties
2 required
response_upgrade_id
object
1 property
1 required
response_http429
object
1 property
upgrade_org_devices_site_ids
array
Only devices belonging to these sites will be selected for upgrade. Will be ignored if allsites==true
ssr_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
upgrade_device_status
string
status upgrade is in. enum: cancelled, completed, created, downloaded, downloading, failed, upgrading, queued
upgrade_site_devices_device_ids
array
id's of devices which will be selected for upgrade
ssr_upgrade_strategy
string
enum: bigbang: upgrade all at once serial: one at a time
upgrade_devices_max_failures
array
If strategy==canary. Number of failures allowed within each phase. Only applicable for canary. Array length should be same as canaryphases. Will be used if pro…
upgrade_device_rule
object
id
string
Unique ID of the object instance in the Mist Organization
upgrade_org_devices_version_model_version
object
If firmwaretype==junos, used to select different versions for different models (Overrides version for the specified models). Property key is the hadware model…
upgrade_org_devices_version_firmware_type
string
enum: ap, junos
upgrade_devices_plan
array
List of Devices MAC Addresses part of the phase
response_http403
object
1 property
upgrade_device_rrm_mesh_upgrade
string
For APs only and if strategy==rrm. Whether to upgrade mesh AP’s parallelly or sequentially at the end of the upgrade. enum: parallel, sequential
mxedge_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
site_id
string
upgrade_devices_targets_failed
array
List of devices MAC Addresses which have failed to upgrade
upgrade_org_devices_list
array
response_http404
object
1 property
upgrade_devices_targets_upgraded
array
Count of devices which have upgraded successfully
mxedge_upgrade_version
object
Version to upgrade for each service, current / latest / default / specific version (e.g. 2.5.100).\nIgnored if distro upgrade, tunterm, radsecproxy, mxagent, m…
5 properties
2 required
device_type_default_ap
string
enum: ap, gateway, switch
response_http400
object
1 property
upgrade_devices_targets_rebooted
array
List of devices MAC Addresses which have rebooted successfully
response_mxedge_upgrades
array
ssr_upgrade_multi
object
6 properties
1 required
response_ssr_upgrade_status
object
6 properties
5 required
upgrade_org_devices_item_site_upgrade
object
2 properties
response_site_device_upgrades
array
upgrade_org_devices_models
array
Only devices of these model types will be selected for upgrade
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Juniper Mist AI 12
Other APIs Juniper Mist AI publishes across the network.
Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API
#Utilities Upgrade