Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Sites Devices - Wired - Virtual Chassis API

API Calls specific to the Juniper Switches Virtual Chassis managed by Mist

Juniper Mist AI Sites Devices - Wired - Virtual Chassis 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 Sites Devices - Wired - Virtual Chassis. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 47 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.

7 operations 4 paths 47 schemas 1 DELETE1 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Sites Devices - Wired - Virtual Chassis 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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 1 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites Devices - Wired - Virtual Chassis 7

API Calls specific to the Juniper Switches Virtual Chassis managed by Mist

POST
/api/v1/sites/{site_id}/devices/{device_id}/set_vc_port_mode
changeSiteSwitchVcPortMode
changeSiteSwitchVcPortMode 2 params body → 200400401403404429
DELETE
/api/v1/sites/{site_id}/devices/{device_id}/vc
deleteSiteVirtualChassis
deleteSiteVirtualChassis 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/devices/{device_id}/vc
getSiteDeviceVirtualChassis
getSiteDeviceVirtualChassis 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/vc
createSiteVirtualChassis
createSiteVirtualChassis 2 params body → 200400401403404429
PUT
/api/v1/sites/{site_id}/devices/{device_id}/vc
updateSiteVirtualChassisMember
updateSiteVirtualChassisMember 2 params body → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/vc/convert_to_virtualmac
convertSiteVirtualChassisToVirtualMac
convertSiteVirtualChassisToVirtualMac 2 params → 200400401403404429
POST
/api/v1/sites/{site_id}/devices/{device_id}/vc/vc_port
setSiteVcPort
setSiteVcPort 2 params body → 200400401403404429

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are stats_switch_module_stat_item (35 properties), response_virtual_chassis_config (13 properties), cpu_stat (6 properties), module_stat_item_errors_items (5 properties). Each schema is shown below with its type and property counts.

module_stat_item_pics_item
object
3 properties
virtual_chassis_update_members
array
virtual_chassis_port_members
array
id
string
Unique ID of the object instance in the Mist Organization
virtual_chassis_update
object
Virtual Chassis
5 properties
response_virtual_chassis_config
object
13 properties
strings
array
response_http403
object
1 property
virtual_chassis_config_member
object
5 properties 2 required
virtual_chassis_member_update_vc_ports
array
Required if op==add or op==preprovision
module_stat_item_psus
array
virtual_chassis_config
object
Virtual Chassis
3 properties
stats_switch_module_stat
array
site_id
string
stats_switch_module_stat_item
object
35 properties
last_seen
numbernull
Last seen timestamp
response_http404
object
1 property
virtual_chassis_member_update
object
5 properties
response_http400
object
1 property
module_stat_item_errors
array
Used to report all error states the device node is running into. An error should always have type and since fields, and could have some other fields specific t…
module_stat_item_vc_links_item
object
3 properties
cpu_stat
object
6 properties
vc_port
object
1 property
module_stat_item_pics_item_port_groups
array
response_http429
object
1 property
module_stat_item_psus_item
object
2 properties
module_stat_item_pics
array
module_stat_item_fans
array
module_stat_item_fans_items
object
4 properties
vc_port_mode
string
enum: network, vcp-higig, vcp-hgoe
virtual_chassis_port_operation
string
enum: delete, set
memory_stat
object
Memory usage stat (for virtual chassis, memory usage of master RE)
1 property 1 required
config_vc_port_member
object
2 properties 1 required
module_stat_item_temperatures
array
module_stat_item_vc_links
array
module_stat_item_errors_items
object
5 properties 2 required
module_stat_item_poe
object
3 properties
virtual_chassis_config_members
array
virtual_chassis_config_member_vc_role
string
enum: backup, linecard, master
virtual_chassis_update_op
string
enum: add, preprovision, remove, renumber
virtual_chassis_member_update_vc_role
string
Required if op==add or op==preprovision. enum: backup, linecard, master
response_http401
object
1 property
org_id
string
cpu_stat_load_avg
array
Load averages for the last 1, 5, and 15 minutes
module_stat_item_temperatures_item
object
3 properties
virtual_chassis_port
object
2 properties 2 required
module_stat_item_pics_item_port_groups_item
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-devices-wired-virtual-chassis-api-openapi.yml Raw ↑

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