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

Mist Installer API

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.

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

This API exposes 23 operations across 16 paths, and defines 95 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.

23 operations 16 paths 95 schemas 3 DELETE9 GET7 POST4 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
License
Resource Areas
1

Authentication & Security 2

Mist Installer 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 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…

GET
/api/v1/installer/orgs/{org_id}/alarmtemplates
listInstallerAlarmTemplates
listInstallerAlarmTemplates 1 param → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/deviceprofiles
listInstallerDeviceProfiles
listInstallerDeviceProfiles 2 params → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/devices
listInstallerListOfRecentlyClaimedDevices
listInstallerListOfRecentlyClaimedDevices 6 params → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/devices
claimInstallerDevices
claimInstallerDevices 1 param body → 200400401403404429
DELETE
/api/v1/installer/orgs/{org_id}/devices/{device_mac}
unassignInstallerRecentlyClaimedDevice
unassignInstallerRecentlyClaimedDevice 2 params → 200400401403404429
PUT
/api/v1/installer/orgs/{org_id}/devices/{device_mac}
provisionInstallerDevices
provisionInstallerDevices 2 params body → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/devices/{device_mac}/locate
startInstallerLocateDevice
startInstallerLocateDevice 2 params → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocate
stopInstallerLocateDevice
stopInstallerLocateDevice 2 params → 200400401403404429
DELETE
/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}
deleteInstallerDeviceImage
deleteInstallerDeviceImage 3 params → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}
addInstallerDeviceImage
addInstallerDeviceImage 3 params body → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc
getInstallerDeviceVirtualChassis
getInstallerDeviceVirtualChassis 2 params → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc
createInstallerVirtualChassis
createInstallerVirtualChassis 2 params body → 200400401403404429
PUT
/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc
updateInstallerVirtualChassisMember
updateInstallerVirtualChassisMember 2 params body → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/rftemplates
listInstallerRfTemplatesNames
listInstallerRfTemplatesNames 1 param → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/sitegroups
listInstallerSiteGroups
listInstallerSiteGroups 1 param → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/sites
listInstallerSites
listInstallerSites 1 param → 200400401403404429
PUT
/api/v1/installer/orgs/{org_id}/sites/{site_name}
createOrUpdateInstallerSites
createOrUpdateInstallerSites 2 params body → 200400401403404429
GET
/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps
listInstallerMaps
listInstallerMaps 2 params → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/import
importInstallerMap
importInstallerMap 2 params body → 200400401403404429
DELETE
/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}
deleteInstallerMap
deleteInstallerMap 3 params → 200400401403404429
POST
/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}
createInstallerMap
createInstallerMap 3 params body → 200400401403404429
PUT
/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}
updateInstallerMap
updateInstallerMap 3 params body → 200400401403404429
GET
/api/v1/installer/sites/{site_name}/optimize
optimizeInstallerRrm
optimizeInstallerRrm 1 param → 200400401403404429

Schemas 95

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.

virtual_chassis_member_update_vc_role
string
Required if op==add or op==preprovision. enum: backup, linecard, master
map_type
string
Map type, such as image or google. enum: google, image
org_id
string
Unique identifier of a Mist organization
virtual_chassis_member_update
object
Member update for a Virtual Chassis add, remove, or preprovision operation
5 properties
module_stat_item_poe
object
Power over Ethernet telemetry for a device module
3 properties
maps
array
Maps or floorplans returned by the API
module_stat_item_vc_links_item
object
Virtual chassis link endpoint for a device module
3 properties
virtual_chassis_update
object
Virtual Chassis member update request
5 properties
response_map_import_summary
object
Counts summarizing assignments made during the map import
3 properties 3 required
claim_codes
array
List of Claim Codes
installer_sites
array
Sites available to installer workflows
strings
array
Unique string values returned or accepted by this schema
map
object
Map or floorplan metadata for a site or organization
31 properties
map_wayfinding_path
object
JSON blob for wayfinding (using Dijkstra’s algorithm)
2 properties
last_seen
numbernull
Timestamp indicating when the entity was last seen
response_inventory
object
Result of adding device claim codes to organization inventory
6 properties
stats_switch_module_stat_item
object
Hardware module status and firmware inventory for a switch
35 properties
response_inventory_error
array
Claim codes rejected by the inventory add operation
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…
response_inventory_added
array
Claim codes accepted into organization inventory
module_stat_item_psus
array
Power supply status records for a device module
response_inventory_inventory_duplicated_items
object
Inventory device already present during the claim operation
5 properties 5 required
module_stat_item_vc_links
array
Virtual chassis link records for a device module
virtual_chassis_update_op
string
enum: add, preprovision, remove, renumber
response_inventory_inventory_added
array
Detailed inventory records added by the claim operation
module_stat_item_pics_item
object
Physical Interface Card summary for a device module
3 properties
response_http403
object
Standard HTTP 403 permission error response
1 property
memory_stat
object
Memory utilization statistics for a device; in a virtual chassis, this reports the master Routing Engine
1 property 1 required
module_stat_item_pics_item_port_groups_item
object
Port group summary for a PIC
2 properties
module_stat_item_pics
array
Physical Interface Card summaries for a device module
response_map_import_ap_action
string
enum: assigned-named-placed, assigned-placed, ignored, named-placed, placed
module_stat_item_temperatures_item
object
Temperature sensor reading for a device module
3 properties
map_sitesurvey_path_items
object
Site survey path definition on a map
4 properties
virtual_chassis_config_member_vc_role
string
enum: backup, linecard, master
installer_device_ble_stat
object
BLE statistics for the device
3 properties
installers
array
Installer access entries returned by list responses
created_time
number
When the object has been created, in epoch
installer_site
object
Site definition available to installer workflows
8 properties 4 required
installer_site_sitegroup_names
array
Site group names associated with an installer site
map_geofence_vertices
array
List of vertices defining the geofence
response_virtual_chassis_config
object
Combined virtual chassis status, topology, and member statistics
13 properties
response_map_import_ap
object
AP placement result from a map import
7 properties 5 required
response_map_import_aps
array
AP placement results produced by the map import
map_wayfinding_micello
object
Micello wayfinding integration settings
3 properties
map_wayfinding_path_nodes
array
Map nodes included in a wayfinding path
map_wall_path
object
JSON blob for wall definition (same format as wayfindingpath)
2 properties
map_geofence
object
Geofence drawn on a map
2 properties
module_stat_item_fans
array
Cooling fan status records for a device module
map_node
object
Node in a map path graph
3 properties 1 required
lat_lng
object
Geographic latitude and longitude coordinate pair
2 properties 2 required
virtual_chassis_member_update_vc_ports
array
Required if op==add or op==preprovision
module_stat_item_fans_items
object
Cooling fan telemetry for a device module
4 properties
map_sitesurvey_path
array
Site survey path definitions for a map
installer_device
object
Recently claimed device visible to installer workflows
19 properties
map_geofence_vertice
object
Vertex coordinate for a map geofence polygon
2 properties
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
module_stat_item_psus_item
object
Power supply status for a device module
2 properties
map_geofences
array
List of geofences for the map
module_stat_item_pics_item_port_groups
array
Port group summaries for a PIC
installer_devices
array
Recently claimed devices available to installer workflows
map_wayfinding
object
Properties related to wayfinding
2 properties
map_wall_path_nodes
array
Map nodes included in a wall path
map_sitesurvey_path_items_nodes
array
Map nodes included in a site survey path
virtual_chassis_update_members
array
Member updates for a Virtual Chassis operation
response_inventory_inventory_added_items
object
Inventory device added by the claim operation
5 properties 5 required
map_import_json
object
Options for importing map data from Ekahau or iBwave JSON
4 properties 1 required
response_http400
object
Standard HTTP 400 bad request error response
1 property
response_map_import
object
Result of importing map files and matching AP placements
5 properties 4 required
map_view
stringnull
if type==google. enum: hybrid, roadmap, satellite, terrain
response_inventory_duplicated
array
Claim codes already present in organization inventory
map_site_import_file
object
Multipart payload for importing map files at site scope
4 properties
installers_item
object
Installer access entry with scope and role details
2 properties
virtual_chassis_config_members
array
Virtual Chassis member configurations
response_inventory_inventory_duplicated
array
Detailed inventory records already present during the claim operation
module_stat_item_errors_items
object
Error condition reported for a device module
5 properties 2 required
modified_time
number
When the object has been modified for the last time, in epoch
stats_switch_module_stat
array
Hardware module statistics reported by a switch
virtual_chassis_config_member
object
Virtual Chassis member configuration
5 properties 2 required
cpu_stat_load_avg
array
Load averages for the last 1, 5, and 15 minutes
response_http404
object
Standard HTTP 404 not found error response
1 property
installer_provision_device
object
Installer payload for provisioning or replacing a device
12 properties 1 required
response_map_import_floorplan
object
Floorplan result from a map import
5 properties 4 required
site_id
string
Unique identifier of a Mist site
response_detail_string
object
Response containing a human-readable detail message
1 property
map_import_json_vendor_name
string
Map import vendor for the uploaded JSON. enum: ekahau, ibwave
response_map_import_floorplans
array
Floorplan import results produced by the map import
latlng_tl
object
When type==google, latitude and longitude of the top-left corner
2 properties
latlng_br
object
When type==google, latitude and longitude of the bottom-right corner
2 properties
virtual_chassis_config
object
Virtual Chassis creation or configuration request
3 properties
module_stat_item_temperatures
array
Temperature sensor readings for a device module
map_node_position
object
Position of a map path node
2 properties 2 required
device_type_default_ap
string
enum: ap, gateway, switch
cpu_stat
object
CPU utilization breakdown for a device
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-installer-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist MSPs Admins API
Mist MSPs API
Mist MSPs Inventory API
Where this information came from

This is an independent, third-party profile of Mist Installer 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.