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
Juniper Networks

Juniper Networks 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

Juniper Networks Utilities Upgrade API is one of 263 APIs that Juniper Networks 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, an API reference, API documentation, a getting-started guide, and rate-limit docs.

This API exposes 29 operations across 21 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 2607.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 56 schemas 14 GET13 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2607.1.1
Base URL
netconf://[device-ip]:830
Authentication
API Key, API Key
Contact
Thomas Munzer
Resource Areas
1

Authentication & Security 2

Juniper Networks 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]($e/Admins%20Login/login) request, Mist returns a csrftoken cookie.…

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 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are upgrade_org_devices (26 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.

ssr_upgrade
object
Request to upgrade a single SSR device
5 properties 1 required
mxedge_upgrade_channel1
string
Upgrade channel to use for qualified versions. enum: alpha, beta, stable.
upgrade_devices_targets3
object
Device targets grouped by upgrade and download status
10 properties
upgrade_device_strategy_deprecated
string
Deprecated; use downloadstrategy and rebootstrategy instead. bigbang (upgrade all at once, no orchestration), serial (one at a time), canary, or rrm (AP only);…
upgrade_device_rrm_mesh_upgrade1
string
For APs only and if strategy==rrm. Mesh AP upgrade order for the organization upgrade. enum: parallel, sequential.
ssr_upgrade_multi
object
Request to upgrade multiple SSR devices
7 properties 1 required
upgrade_org_devices_item_site_upgrade
object
Site upgrade mapping returned for an organization upgrade
2 properties
version_string
object
JSI device upgrade target version request
1 property
ssr_version_channel
string
enum: stable, beta, alpha
mxedge_upgrade_multi_allow_downgrades2
object
Per-service downgrade permission settings for this upgrade
5 properties
upgrade_device_rrm_mesh_upgrade2
string
For APs only and if strategy==rrm. Mesh AP upgrade order for the site upgrade. enum: parallel, sequential.
upgrade_org_devices_item
object
Organization device upgrade job returned by upgrade APIs
2 properties
response_ssr_upgrade
object
SSR firmware upgrade job summary
8 properties 7 required
ssr_upgrade_channel1
string
Firmware release channel to use for the SSR upgrade. enum: alpha, beta, stable.
upgrade_device_strategy4
string
Device reboot orchestration strategy for selected devices. enum: bigbang, canary, rrm, serial.
upgrade_device_rrm_node_order1
string
For APs only and if strategy==rrm. AP ordering direction for RRM upgrade batches. enum: centertofringe, fringetocenter.
response_device_upgrade
object
Single-device upgrade status response
2 properties 2 required
device_type_default_ap
string
enum: ap, gateway, switch
mxedge_upgrade_version2
object
Per-service target versions for the upgrade request
5 properties 2 required
response_ssr_upgrade_counts
object
Device counts grouped by SSR upgrade status
4 properties 4 required
upgrade_info_status2
string
Current status of the requested device upgrade. enum: error, inprogress, scheduled, starting, success.
response_http404
object
Standard HTTP 404 not found error response
1 property
response_site_device_upgrades_item
object
Site device upgrade job summary
13 properties 1 required
upgrade_device_strategy2
string
Execution strategy used for the organization upgrade job. enum: bigbang, canary, rrm, serial.
upgrade_org_devices_upgrade
object
Upgrade entry for a single site within an organization upgrade job
2 properties
upgrade_site_devices
object
Site device upgrade request
21 properties
mxedge_upgrade_response_counts1
object
Per-status counts of Mist Edge targets in this upgrade
4 properties 4 required
device_upgrade
object
Device firmware upgrade request options
5 properties 1 required
upgrade_site_devices_counts2
object
Device counts grouped by upgrade status for this job
9 properties
mxedge_upgrade_multi
object
Request to schedule upgrades for one or more Mist Edges
9 properties 1 required
ssr_upgrade_strategy2
string
Upgrade rollout strategy for the targeted SSR devices. enum: bigbang, serial.
response_upgrade_org_devices
object
Organization AP upgrade job details
6 properties
response_http403
object
Standard HTTP 403 permission error response
1 property
response_upgrade_id
object
Response containing an upgrade job identifier
1 property 1 required
upgrade_org_devices_version_firmware_type2
string
Firmware family this version entry applies to. enum: ap, junos, ssr.
response_http400
object
Standard HTTP 400 bad request error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
device_version_item
object
Available firmware version for a specific device model and release tag
3 properties 2 required
response_site_device_upgrade
object
Site device upgrade job details
16 properties 1 required
ssr_version
object
SSR firmware version available for upgrade
4 properties 2 required
upgrade_device_strategy5
string
Upgrade orchestration strategy for selected devices. enum: bigbang, canary, rrm, serial.
upgrade_org_devices_version
object
Target firmware version entry for an organization upgrade request
4 properties
response_ssr_upgrade_status
object
Detailed status for an SSR firmware upgrade job
8 properties 5 required
upgrade_device_status
string
status upgrade is in. enum: cancelled, completed, created, downloaded, downloading, failed, upgrading, queued
upgrade_org_devices_download_strategy2
string
Firmware download orchestration strategy for the organization upgrade. enum: canary, bigbang, serial.
device_type5
string
Device family selected for the organization upgrade. enum: ap, gateway, switch.
upgrade_device_status2
string
Current status of the site-level upgrade job. enum: cancelled, completed, created, downloaded, downloading, failed, queued, upgrading.
upgrade_org_devices_upgrade_info2
object
Site-level job details for this upgrade entry
4 properties
upgrade_org_devices
object
Organization-wide device upgrade request
26 properties
mxedge_upgrade_strategy2
string
Upgrade rollout strategy for the selected Mist Edges. enum: canary, bigbang, serial.
response_mxedge_upgrade
object
Mist Edge upgrade details response
6 properties 6 required
response_http401
object
Standard HTTP 401 authentication error response
1 property
upgrade_device_status1
string
Current status of the site device upgrade job. enum: cancelled, completed, created, downloaded, downloading, failed, queued, upgrading.
upgrade_device_strategy1
string
Device upgrade strategy used by this job. enum: bigbang, canary, rrm, serial.
upgrade_devices_targets1
object
Device targets grouped by upgrade state
10 properties
response_ssr_upgrade_status_targets
object
SSR device IDs grouped by upgrade status
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Juniper Networks publishes across the network.

Junos PyEZ (Python API)
AE Profile APIs.io
JSNAPy API
AE Profile APIs.io
Juniper Networks Allowlists and Blocklists API
AE Profile APIs.io
Juniper Networks Analytics API
AE Profile APIs.io
Juniper Networks Audit Logs API
AE Profile APIs.io
Juniper Networks Authentication API
AE Profile APIs.io
Juniper Networks BGP Routers API
AE Profile APIs.io
Juniper Networks Blueprints API
AE Profile APIs.io
Juniper Networks Clients API
AE Profile APIs.io
Juniper Networks Configlets API
AE Profile APIs.io
Juniper Networks Configuration API
AE Profile APIs.io
Juniper Networks Connectivity Templates API
AE Profile APIs.io
#Utilities Upgrade
← Back to J APIs
API Details
ID
juniper:juniper-utilities-upgrade-api
Base URL
netconf://[device-ip]:830
Docs
https://www.juniper.net/documentation/product/us/en/junos-pyez/
Provider
Juniper Networks
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=juniper-utilities-upgrade-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/juniper-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 Juniper Networks 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.