How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mist

Mist Utilities Upgrade API

API Calls used to manage device upgrades for a single device, at the site level or at the organization level.

Documentation Provider Profile APIs.io OpenAPI GitHub

Mist Utilities Upgrade API is one of 212 APIs that Mist 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.

This API exposes 29 operations across 21 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.

Specification
OpenAPI 3.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
Contact
Thomas Munzer
License
MIT
Resource Areas
1

Authentication & Security 2

Mist Utilities Upgrade API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

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
listOrgDeviceUpgrades 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/devices/upgrade
upgradeOrgDevices
upgradeOrgDevices 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}
getOrgDeviceUpgrade
getOrgDeviceUpgrade 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/devices/upgrade/{upgrade_id}/cancel
cancelOrgDeviceUpgrade
cancelOrgDeviceUpgrade 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/devices/versions
listOrgAvailableDeviceVersions
listOrgAvailableDeviceVersions 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/jsi/devices/{device_mac}/upgrade
upgradeOrgJsiDevice
upgradeOrgJsiDevice 2 params body → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/upgrade
listOrgMxEdgeUpgrades
listOrgMxEdgeUpgrades 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/upgrade
upgradeOrgMxEdges
upgradeOrgMxEdges 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}
getOrgMxEdgeUpgrade
getOrgMxEdgeUpgrade 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}
updateOrgMxEdgeUpgrade
updateOrgMxEdgeUpgrade 2 params body → 200400401403404429
POST
/api/v1/orgs/{org_id}/mxedges/upgrade/{upgrade_id}/cancel
cancelOrgMxEdgeUpgrade
cancelOrgMxEdgeUpgrade 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/ssr/upgrade
listOrgSsrUpgrades
listOrgSsrUpgrades 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/ssr/upgrade
upgradeOrgSsrs
upgradeOrgSsrs 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/ssr/upgrade/{upgrade_id}/cancel
getOrgSsrUpgrade
getOrgSsrUpgrade 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/ssr/upgrade/{upgrade_id}/cancel
cancelOrgSsrUpgrade
cancelOrgSsrUpgrade 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/ssr/versions
listOrgAvailableSsrVersions
listOrgAvailableSsrVersions 3 params → 200400401403404429
GET
/api/v1/sites/{site_id}/devices/upgrade
listSiteDeviceUpgrades
listSiteDeviceUpgrades 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/upgrade
upgradeSiteDevices
upgradeSiteDevices 1 param body → 200400401403404429
GET
/api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}
getSiteDeviceUpgrade
getSiteDeviceUpgrade 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/upgrade/{upgrade_id}/cancel
cancelSiteDeviceUpgrade
cancelSiteDeviceUpgrade 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/devices/versions
listSiteAvailableDeviceVersions
listSiteAvailableDeviceVersions 3 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/upgrade
upgradeDevice
upgradeDevice 2 params body → 200400401403404429
GET
/api/v1/sites/{site_id}/mxedges/upgrade
listSiteMxEdgeUpgrades
listSiteMxEdgeUpgrades 1 param → 200400401403404429
POST
/api/v1/sites/{site_id}/mxedges/upgrade
upgradeSiteMxEdges
upgradeSiteMxEdges 1 param body → 200400401403404429
GET
/api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}
getSiteMxEdgeUpgrade
getSiteMxEdgeUpgrade 2 params → 200400401403404429
PUT
/api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}
updateSiteMxEdgeUpgrade
updateSiteMxEdgeUpgrade 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/mxedges/upgrade/{upgrade_id}/cancel
cancelSiteMxEdgeUpgrade
cancelSiteMxEdgeUpgrade 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/ssr/upgrade/{upgrade_id}
getSiteSsrUpgrade
getSiteSsrUpgrade 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/ssr/{device_id}/upgrade
upgradeSsr
upgradeSsr 2 params body → 200400401403404429

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_org_devices_item_site_upgrades
array
Site-level upgrade jobs created for an organization upgrade
upgrade_devices_targets_failed
array
List of device MAC addresses that failed to upgrade
upgrade_org_devices_upgrade
object
Upgrade entry for a single site within an organization upgrade job
2 properties
ssr_upgrade
object
Request to upgrade a single SSR device
4 properties 1 required
response_ssr_upgrades
array
SSR firmware upgrade jobs returned by list operations
response_ssr_upgrade
object
SSR firmware upgrade job summary
7 properties 7 required
strings
array
Unique string values returned or accepted by this schema
upgrade_devices_targets_downloaded
array
List of device MAC addresses that have downloaded the firmware
device_version_item
object
Available firmware version for a specific device model and release tag
3 properties 2 required
upgrade_org_devices_item
object
Organization device upgrade job returned by upgrade APIs
2 properties
ssr_upgrade_multi
object
Request to upgrade multiple SSR devices
6 properties 1 required
response_mxedge_upgrade
object
Mist Edge upgrade details response
6 properties 6 required
upgrade_device_strategy
string
enum: bigbang (upgrade all at once), canary, rrm (APs only), serial (one at a time)
upgrade_devices_targets_downloading
array
List of device MAC addresses that are currently downloading the firmware
upgrade_org_devices_upgrade_infos
array
Per-site upgrade entries created for an organization device upgrade
upgrade_devices_targets_scheduled
array
List of device MAC addresses that the cloud scheduled an upgrade for
response_http403
object
Standard HTTP 403 permission error response
1 property
upgrade_device_models
array
Models which will be selected for upgrade
response_site_device_upgrade
object
Site device upgrade job details
16 properties 1 required
response_ssr_upgrade_counts
object
Device counts grouped by SSR upgrade status
4 properties 4 required
mxedge_upgrade_multi_allow_downgrades
object
Whether downgrade is allowed when running version is higher than expected version for each service
5 properties
upgrade_devices_targets_skipped
array
List of device MAC addresses that skipped upgrade because requested version was same as running version. Use force to always upgrade
device_type
string
enum: ap, gateway, switch
response_device_upgrade
object
Single-device upgrade status response
2 properties 2 required
mxedge_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
upgrade_org_devices_version_firmware_type
string
Firmware family this version entry applies to. enum: ap, junos
upgrade_devices_targets
object
Read-only device target lists grouped by upgrade status
10 properties
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,…
upgrade_devices_targets_upgraded
array
List of device MAC addresses that upgraded successfully
upgrade_devices_targets_rebooted
array
List of device MAC addresses that rebooted successfully
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
upgrade_devices_plans
object
If strategy!=bigbang, a dictionary of phase number to devices part of that phase
device_version
array
Available firmware versions for device models
upgrade_site_devices_counts
object
Device counts grouped by status for a site upgrade job
9 properties
upgrade_org_devices_list
array
Organization device upgrade jobs returned by a list response
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.
upgrade_devices_targets_download_requested
array
List of device MAC addresses that the cloud requested to download firmware
response_upgrade_id
object
Response containing an upgrade job identifier
1 property 1 required
ssr_version
object
SSR firmware version available for upgrade
4 properties 2 required
response_site_device_upgrades_item
object
Site device upgrade job summary
13 properties 1 required
upgrade_site_devices
object
Site device upgrade request
21 properties
ssr_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
upgrade_device_rule
object
Device selection rule keyed by match criterion, with string values to match
upgrade_devices_plan
array
List of Devices MAC addresses part of the phase
upgrade_org_devices_upgrade_info
object
Site-level upgrade job details within an organization upgrade
4 properties
ssr_version_channel
string
enum: stable, beta, alpha
timestamp
number
Epoch timestamp, in seconds
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…
version_string
object
JSI device upgrade target version request
1 property
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…
ssr_upgrade_strategy
string
enum: bigbang: upgrade all at once serial: one at a time
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
id
string
Unique ID of the object instance in the Mist Organization
response_site_device_upgrades
array
Site device upgrade jobs returned by list operations
upgrade_org_devices_version
object
Target firmware version entry for an organization upgrade request
4 properties
mxedge_upgrade_multi_mxedge_ids
array
List of Mist Edge IDs to upgrade. If not specified, it means all the org Mist Edges.
device_upgrade
object
Device firmware upgrade request options
5 properties 1 required
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…
upgrade_org_devices_versions
array
Target firmware version entries for an organization upgrade request
upgrade_site_devices_device_ids
array
Device IDs selected for a site device upgrade
mxedge_upgrade_multi
object
Request to schedule upgrades for one or more Mist Edges
9 properties 1 required
upgrade_org_devices_download_strategy
string
enum: bigbang: download all at once, no orchestration serial: one at a time' canary: upgrade in phases
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
response_http400
object
Standard HTTP 400 bad request error response
1 property
response_ssr_upgrade_status
object
Detailed status for an SSR firmware upgrade job
6 properties 5 required
upgrade_org_devices_site_ids
array
Only devices belonging to these sites will be selected for upgrade. Will be ignored if allsites==true
ssr_versions
array
SSR firmware versions available for upgrade
upgrade_devices_targets_reboot_in_progress
array
List of device MAC addresses for devices that are rebooting
mxedge_upgrade_response_counts
object
Counts of Mist Edge upgrades by current status
4 properties 4 required
response_upgrade_org_devices
object
Organization AP upgrade job details
6 properties
upgrade_org_devices
object
Organization-wide device upgrade request
24 properties
response_ssr_upgrade_status_targets
object
SSR device IDs grouped by upgrade status
4 properties 4 required
response_http404
object
Standard HTTP 404 not found error response
1 property
upgrade_devices_max_failure_percentage
integer
If strategy!=bigbang. percentage of failures allowed across the entire upgrade
upgrade_org_devices_item_site_upgrade
object
Site upgrade mapping returned for an organization upgrade
2 properties
site_id
string
Unique identifier of a Mist site
mxedge_upgrade_strategy
string
enum: bigbang: upgrade all at once, no orchestration serial: one at a time' canary: upgrade in phases
upgrade_info_status
string
enum: error, inprogress, scheduled, starting, success
upgrade_org_devices_models
array
Only devices of these model types will be selected for upgrade
response_mxedge_upgrades
array
Mist Edge upgrade records returned by list upgrade operations
upgrade_device_status
string
status upgrade is in. enum: cancelled, completed, created, downloaded, downloading, failed, upgrading, queued
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
ssr_upgrade_multi_device_ids
array
List of 128T device IDs to upgrade

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-utilities-upgrade-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
AE Profile APIs.io
Mist Admins Login API
AE Profile APIs.io
Mist Admins Login - OAuth2 API
AE Profile APIs.io
Mist Admins Logout API
AE Profile APIs.io
Mist Admins Lookup API
AE Profile APIs.io
Mist Admins Recover Password API
AE Profile APIs.io
Mist Constants Definitions API
AE Profile APIs.io
Mist Constants Events API
AE Profile APIs.io
Mist Constants Models API
AE Profile APIs.io
Mist Installer API
AE Profile APIs.io
Mist MSPs Admins API
AE Profile APIs.io
Mist MSPs API
AE Profile APIs.io
#Utilities Upgrade
← Back to M APIs
API Details
ID
mist:mist-utilities-upgrade-api
Base URL
https://api.mist.com/api/v1
Docs
https://www.juniper.net/documentation/us/en/software/mist/automation-integration/
Provider
Mist
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mist-utilities-upgrade-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mist-utilities-upgrade-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Mist Utilities Upgrade API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.