# Mist Installer API

**Canonical:** https://apis.io/apis/mist/mist-installer-api/  
**Provider:** Mist — https://apis.io/providers/mist/  
**Base URL:** https://api.mist.com/api/v1  
**Documentation:** https://www.juniper.net/documentation/us/en/software/mist/automation-integration/

Mist Installer API is one of 212 APIs that [Mist](https://apis.io/providers/mist/) publishes on the [APIs.io](https://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.

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 installing 3. 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.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/installer/orgs/{org_id}/alarmtemplates` | listInstallerAlarmTemplates |
| GET | `/api/v1/installer/orgs/{org_id}/deviceprofiles` | listInstallerDeviceProfiles |
| GET | `/api/v1/installer/orgs/{org_id}/devices` | listInstallerListOfRecentlyClaimedDevices |
| POST | `/api/v1/installer/orgs/{org_id}/devices` | claimInstallerDevices |
| DELETE | `/api/v1/installer/orgs/{org_id}/devices/{device_mac}` | unassignInstallerRecentlyClaimedDevice |
| PUT | `/api/v1/installer/orgs/{org_id}/devices/{device_mac}` | provisionInstallerDevices |
| POST | `/api/v1/installer/orgs/{org_id}/devices/{device_mac}/locate` | startInstallerLocateDevice |
| POST | `/api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocate` | stopInstallerLocateDevice |
| DELETE | `/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}` | deleteInstallerDeviceImage |
| POST | `/api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}` | addInstallerDeviceImage |
| GET | `/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc` | getInstallerDeviceVirtualChassis |
| POST | `/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc` | createInstallerVirtualChassis |
| PUT | `/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc` | updateInstallerVirtualChassisMember |
| GET | `/api/v1/installer/orgs/{org_id}/rftemplates` | listInstallerRfTemplatesNames |
| GET | `/api/v1/installer/orgs/{org_id}/sitegroups` | listInstallerSiteGroups |
| GET | `/api/v1/installer/orgs/{org_id}/sites` | listInstallerSites |
| PUT | `/api/v1/installer/orgs/{org_id}/sites/{site_name}` | createOrUpdateInstallerSites |
| GET | `/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps` | listInstallerMaps |
| POST | `/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/import` | importInstallerMap |
| DELETE | `/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}` | deleteInstallerMap |
| POST | `/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}` | createInstallerMap |
| PUT | `/api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}` | updateInstallerMap |
| GET | `/api/v1/installer/sites/{site_name}/optimize` | optimizeInstallerRrm |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-installer-api-openapi.yml

## Other Mist APIs (12)

- [Mist Admins API](https://apis.io/apis/mist/mist-admins-api/)
- [Mist Admins Login API](https://apis.io/apis/mist/mist-admins-login-api/)
- [Mist Admins Login - OAuth2 API](https://apis.io/apis/mist/mist-admins-login-oauth2-api/)
- [Mist Admins Logout API](https://apis.io/apis/mist/mist-admins-logout-api/)
- [Mist Admins Lookup API](https://apis.io/apis/mist/mist-admins-lookup-api/)
- [Mist Admins Recover Password API](https://apis.io/apis/mist/mist-admins-recover-password-api/)
- [Mist Constants Definitions API](https://apis.io/apis/mist/mist-constants-definitions-api/)
- [Mist Constants Events API](https://apis.io/apis/mist/mist-constants-events-api/)
- [Mist Constants Models API](https://apis.io/apis/mist/mist-constants-models-api/)
- [Mist MSPs Admins API](https://apis.io/apis/mist/mist-msps-admins-api/)
- [Mist MSPs API](https://apis.io/apis/mist/mist-msps-api/)
- [Mist MSPs Inventory API](https://apis.io/apis/mist/mist-msps-inventory-api/)

## Tags

Installer

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/mist/mist-installer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/mist/.
