Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
Installer

provisionInstallerDevices

PUT
/api/v1/installer/orgs/{org_id}/devices/{device_mac}

Provision or replace an installer-managed device.

If replacing_mac is in the request payload, other attributes are ignored, we attempt to replace existing device (with MAC address replacing_mac) with the inventory device being configured. The replacement device must be in the inventory but not assigned, and the replacing_mac device must be assigned to a site, and satisfy grace period requirements. The Device replaced will become unassigned.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
device_mac*string
Match^[0-9a-fA-F]{12}$

Request Body

application/json

Request Body

Installer payload for provisioning or replacing a device

deviceprofile_name?string

Profile name applied to the device during installer provisioning

height?number

Mounting height recorded for map placement

Formatdouble
map_id?string

Identifier of the map where the device should be placed

Formatuuid
name*string

Device name to set during installer provisioning

orientation?integer

Device orientation in degrees from 0 to 359, where 0 is up and 90 is right

replacing_mac?string

Only if replacing an existing device; MAC address of the device being replaced

role?string

Optional role for switch / gateway

site_id?string

Identifier of the destination site for installer provisioning

Formatuuid
site_name?string

Destination site name for installer provisioning

x?number

Horizontal map position for the device, in pixels

Formatdouble
y?number

Vertical map position for the device, in pixels

Formatdouble

Response Body

curl -X PUT "https://example.com/api/v1/installer/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "deviceprofile_name": "SJ1",    "height": 2.7,    "name": "SJ1-AP1",    "orientation": 90,    "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",    "site_name": "SJ1",    "x": 150,    "y": 300  }'
Empty

unassignInstallerRecentlyClaimedDevice DELETE

Unassign a recently claimed device from its current site so it can be provisioned again through the installer workflow.

startInstallerLocateDevice POST

Start locating an installer-managed device by blinking its LED. The locate state persists until [Stop Locating Installer Device](/api/mist/installer/stopInstallerLocateDevice) is called.