In a typical enterprise, a separate group of people, Installers, are responsible for install new devices. May it be a new installation (e.g. new stores), a replacement installation (e.g. replacing Cisco APs with Mist APs), or addition (e.g. adding new APs for better coverage). Instead of granting them Admin/Write privilege, it's more desirable to grant them minimum privileges to do the initial provisioning so they cannot read sensible information (e.g. PSK of a WLAN), or change configs of running APs.At a high level, Installer APs try to achieve the following:1. identifying a device by MAC (that\u2019\ s what they see)2. they can only touch configurations of the devices they\u2019\re installing3. allow the following configurations: * name * site assignment * device profile assignment * map and location (x/y) assignment * claim (if not already in the inventory) * replace existing device with the device being installed**Grace Period**Grace period provides a dynamic way to limit what devices / sites installer can work on. Generally installers work on recent deployments - bringing up new sites, add newly claimed devices to new / existing sites. They make mistakes, too, and may need to further tweak some of the parameters. Default grace period is 7 days and can be set from 1 day to 365 days.
Juniper Mist AI Installer 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 Installer. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
23 operations
across 16 paths,
and defines 95 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.
23 operations16 paths95 schemas3 DELETE9 GET7 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Juniper Mist AI Installer 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 23
Across 16 paths, the API surfaces 23 operations — 3 DELETE, 9 GET, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Installer 23
In a typical enterprise, a separate group of people, Installers, are responsible for install new devices. May it be a new installation (e.g. new stores), a replacement installatio…
The contract defines 95 schemas that model the data the API accepts and returns. The most detailed are stats_switch_module_stat_item (35 properties), map (31 properties), installer_device (19 properties), response_virtual_chassis_config (13 properties). Each schema is shown below with its type and property counts.
response_virtual_chassis_config
object
13 properties
claim_codes
array
List of Claim Codes
strings
array
response_inventory
object
6 properties
map_import_json
object
4 properties1 required
response_inventory_inventory_added
array
virtual_chassis_member_update_vc_ports
array
Required if op==add or op==preprovision
map_site_import_file
object
4 properties
response_map_import_summary
object
3 properties3 required
installer_device_ble_stat
object
BLE statistics for the device
3 properties
map_wall_path_nodes
array
response_inventory_inventory_duplicated_items
object
5 properties5 required
map_geofence_vertices
array
List of vertices defining the geofence
virtual_chassis_member_update
object
5 properties
response_inventory_error
array
map_geofences
array
List of geofences for the map
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…
map_wall_path
object
JSON blob for wall definition (same format as wayfindingpath)
2 properties
map_sitesurvey_path_items
object
4 properties
module_stat_item_pics_item_port_groups
array
latlng_br
object
When type=google, latitude / longitude of the bottom-right corner
2 properties
map_sitesurvey_path_items_nodes
array
installer_site
object
8 properties4 required
module_stat_item_vc_links
array
virtual_chassis_member_update_vc_role
string
Required if op==add or op==preprovision. enum: backup, linecard, master
module_stat_item_poe
object
3 properties
virtual_chassis_config_members
array
latlng_tl
object
When type=google, latitude / longitude of the top-left corner