# Juniper Networks Installer API **Canonical:** https://apis.io/apis/juniper/juniper-installer-api/ **Provider:** Juniper Networks — https://apis.io/providers/juniper/ **Base URL:** netconf://[device-ip]:830 **Documentation:** https://www.juniper.net/documentation/product/us/en/junos-pyez/ Juniper Networks Installer API is one of 263 APIs that [Juniper Networks](https://apis.io/providers/juniper/) 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, an API reference, API documentation, a getting-started guide, and rate-limit docs. 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 (11) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/openapi/juniper-installer-api-openapi.yml - **GitHub** — https://github.com/mistsys/mist_openapi - **APIReference** — https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/overview/overview - **Documentation** — https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html - **GettingStarted** — https://www.juniper.net/documentation/us/en/software/mist/api/http/getting-started/how-to-get-started - **Webhooks** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/asyncapi/juniper-mist-webhooks.yml - **RateLimits** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/rate-limits/juniper-rate-limits.yml - **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/errors/juniper-problem-types.yml - **Conventions** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/conventions/juniper-conventions.yml - **DataModel** — https://raw.githubusercontent.com/api-evangelist/juniper/refs/heads/main/data-model/juniper-data-model.yml - **StatusPage** — https://mist.statuspage.io/ ## Other Juniper Networks APIs (12) - [Junos PyEZ (Python API)](https://apis.io/apis/juniper/junos-pyez-python-api/) - [JSNAPy API](https://apis.io/apis/juniper/jsnapy-api/) - [Juniper Networks Allowlists and Blocklists API](https://apis.io/apis/juniper/juniper-allowlists-and-blocklists-api/) - [Juniper Networks Analytics API](https://apis.io/apis/juniper/juniper-analytics-api/) - [Juniper Networks Audit Logs API](https://apis.io/apis/juniper/juniper-audit-logs-api/) - [Juniper Networks Authentication API](https://apis.io/apis/juniper/juniper-authentication-api/) - [Juniper Networks BGP Routers API](https://apis.io/apis/juniper/juniper-bgp-routers-api/) - [Juniper Networks Blueprints API](https://apis.io/apis/juniper/juniper-blueprints-api/) - [Juniper Networks Clients API](https://apis.io/apis/juniper/juniper-clients-api/) - [Juniper Networks Configlets API](https://apis.io/apis/juniper/juniper-configlets-api/) - [Juniper Networks Configuration API](https://apis.io/apis/juniper/juniper-configuration-api/) - [Juniper Networks Connectivity Templates API](https://apis.io/apis/juniper/juniper-connectivity-templates-api/) ## Tags Installer --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/juniper/juniper-installer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/juniper/.