Juniper Mist AI Orgs Inventory 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 Orgs Inventory. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
9 operations
across 7 paths,
and defines 50 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.
9 operations7 paths50 schemas3 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Juniper Mist AI Orgs Inventory 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 9
Across 7 paths, the API surfaces 9 operations — 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Orgs Inventory 9
The Org Inventory allows administrators to view and manage all devices registered (claimed) to the Organization.
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are inventory (21 properties), inventory_search_result (13 properties), inventory_update (8 properties), response_count (6 properties). Each schema is shown below with its type and property counts.
tunterm_port_config_upstream_ports
array
List of ports to be used for upstream purpose (to LAN)
claim_codes
array
List of Claim Codes
strings
array
inventory_search_result
object
13 properties
response_inventory
object
6 properties
response_inventory_inventory_added
array
inventory
object
21 properties
response_inventory_inventory_duplicated_items
object
5 properties5 required
tunterm_port_config
object
Ethernet port configurations
4 properties
response_inventory_error
array
ha_cluster_config_nodes
array
inventory_search
object
6 properties
inventory_update
object
8 properties1 required
inventory_search_results
array
device_type
string
enum: ap, gateway, switch
response_http401
object
1 property
ha_cluster_delete
object
1 property
response_count
object
6 properties6 required
replace_device_discard
array
Attributes that you don’t want to copy
inventory_update_serials
array
If op==delete, list of serial numbers, e.g. ["FXLH2015150025"]
ha_cluster_config
object
5 properties
created_time
number
When the object has been created, in epoch
replace_device
object
5 properties
ha_cluster_config_node
object
1 property
count_result
object
1 property1 required
device_status_filter
string
Filter devices based on their status. enum: connected, disconnected
inventory_count_distinct
string
enum: model, status, siteid, sku, version
response_inventory_duplicated
array
inventory_list
array
inventory_search_result_members
array
inventory_search_result_member
object
3 properties
response_http429
object
1 property
tunterm_port_config_downstream_ports
array
List of ports to be used for downstream (to AP) purpose
org_id
string
id
string
Unique ID of the object instance in the Mist Organization
inventory_update_macs
array
If op==assign, op==unassign, op==upgradetomistor op==downgradetojsi , list of MAC, e.g. ["5c5b350e0001"]
response_org_inventory_change
object
4 properties4 required
response_http403
object
1 property
response_inventory_inventory_added_items
object
5 properties5 required
count_results
array
site_id
string
response_http404
object
1 property
response_inventory_added
array
inventory_update_operation
string
enum: upgradetomist: Upgrade to mist-managed downgradetojsi: Downgrade to basic monitoring. When downgrading a VC member to jsi, we will move the cloud connect…
