Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesDevices

updateSiteDevice

PUT
/api/v1/sites/{site_id}/devices/{device_id}

Update Device Configuration

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

site_id*string
Formatuuid
device_id*string
Formatuuid

Request Body

application/json

Request Body

Mist-managed device object for an AP, switch, or gateway

Access point configuration and placement data

aeroscout?

Location integration settings for AeroScout on this access point

airista?

Location integration settings for Airista on this access point

ble_config?

Bluetooth Low Energy beacon and asset settings for this access point

centrak?

Location integration settings for Centrak on this access point

client_bridge?

Wireless client bridge settings for this access point

deviceprofile_id?|

Device profile assigned to this access point

Formatuuid
disable_eth1?boolean

Whether to disable eth1 port

Defaultfalse
disable_eth2?boolean

Whether to disable eth2 port

Defaultfalse
disable_eth3?boolean

Whether to disable eth3 port

Defaultfalse
disable_module?boolean

Whether to disable module port

Defaultfalse
enable_unii_4?boolean

Whether U-NII-4 channels (169, 173, 177) are enabled on this access point

Defaultfalse
esl_config?

Electronic shelf label integration settings for this access point

flow_control?boolean

For some AP models, flow_control can be enabled to address some switch compatibility issue

Defaultfalse
height?number

Installation height of the AP, in meters

Formatdouble
image1_url?|

First custom image URL associated with the access point

image2_url?|

Second custom image URL associated with the access point

image3_url?|

Third custom image URL associated with the access point

iot_config?

Digital and analog IoT pin settings for this access point

ip_config?

Management IP addressing settings for this access point

lacp_config?

Link aggregation settings for supported AP Ethernet uplinks

led?

Indicator light behavior settings for this access point

locked?boolean

Whether this map is considered locked down

map_id?string

Map where the device belongs to

Formatuuid
mesh?

Wireless mesh role and band settings for this access point

mqtt_config?

MQTT broker publishing settings for this access point

name?string

Configured hostname assigned to the access point

notes?string

Any notes about this AP

ntp_servers?array<string>

NTP servers used by this access point

orientation?integer

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

Range0 <= value <= 359
poe_passthrough?boolean

Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)

Defaultfalse
port_config?

eth0 is not allowed here. Property key is the interface(s) name (e.g. eth1 or eth1,eth2). If spcified, this takes predecence over switch_config (switch_config requires user to configure all vlans manually, which is error-prone. thus deprecated)

pwr_config?

Power negotiation and peripheral power settings for this access point

radio_config?

Radio configuration overrides for this access point

uplink_port_config?

Authentication and failover behavior for AP uplink ports

usb_config?

Legacy USB integration settings for this access point

uwb_config?

UWB RTLS / OMLOX asset-visibility settings; overrides the device profile and site-level uwb_config

vars?

Variable values that override site variables for this access point

x?number

Horizontal map position of the AP, in pixels

Formatdouble
y?number

Vertical map position of the AP, in pixels

Formatdouble
zigbee_config?

Zigbee radio and network settings for this access point

Response Body

curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{}'

{  "aeroscout": {    "enabled": false,    "host": "aero.pvt.net",    "locate_connected": true  },  "airista": {    "enabled": false  },  "ble_config": {    "beacon_enabled": false,    "beacon_rate": 3,    "beacon_rate_mode": "custom",    "beam_disabled": [      1,      3,      6    ],    "custom_ble_packet_enabled": false,    "custom_ble_packet_frame": "0x........",    "custom_ble_packet_freq_msec": 300,    "eddystone_uid_adv_power": -65,    "eddystone_uid_beams": "2-4,7",    "eddystone_uid_enabled": false,    "eddystone_uid_freq_msec": 200,    "eddystone_uid_instance": "5c5b35000001",    "eddystone_uid_namespace": "2818e3868dec25629ede",    "eddystone_url_adv_power": -65,    "eddystone_url_beams": "2-4,7",    "eddystone_url_enabled": true,    "eddystone_url_freq_msec": 1000,    "eddystone_url_url": "https://www.abc.com",    "ibeacon_adv_power": -65,    "ibeacon_beams": "2-4,7",    "ibeacon_enabled": false,    "ibeacon_freq_msec": 0,    "ibeacon_major": 13,    "ibeacon_minor": 138,    "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",    "power": 6,    "power_mode": "custom"  },  "centrak": {    "enabled": false  },  "client_bridge": {    "auth": {      "psk": "foryoureyesonly",      "type": "psk"    },    "enabled": false,    "ssid": "Uplink-SSID"  },  "created_time": 0,  "deviceprofile_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9",  "disable_eth1": false,  "disable_eth2": false,  "disable_eth3": false,  "disable_module": false,  "esl_config": {    "cacert": "string",    "channel": 3,    "enabled": false,    "host": "1.1.1.1",    "port": 0,    "type": "imagotag",    "verify_cert": true,    "vlan_id": 1  },  "for_site": true,  "height": 2.75,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6008",  "image1_url": "string",  "image2_url": "string",  "image3_url": "string",  "iot_config": {    "A1": {      "enabled": false,      "name": "motion",      "output": true,      "pullup": "internal",      "value": 0    },    "A2": {      "enabled": false,      "name": "motion",      "output": true,      "pullup": "internal",      "value": 0    },    "A3": {      "enabled": false,      "name": "motion",      "output": true,      "pullup": "internal",      "value": 0    },    "A4": {      "enabled": false,      "name": "motion",      "output": true,      "pullup": "internal",      "value": 0    },    "DI1": {      "enabled": false,      "name": "string",      "pullup": "internal"    },    "DI2": {      "enabled": false,      "name": "string",      "pullup": "internal"    },    "DO": {      "enabled": false,      "name": "motion",      "output": true,      "pullup": "internal",      "value": 0    }  },  "ip_config": {    "dns": [      "8.8.8.8",      "4.4.4.4"    ],    "dns_suffix": [      ".mist.local",      ".mist.com"    ],    "gateway": "10.2.1.254",    "gateway6": "2607:f8b0:4005:808::1",    "ip": "10.2.1.1",    "ip6": "2607:f8b0:4005:808::2004",    "mtu": 1500,    "netmask": "255.255.255.0",    "netmask6": "/32",    "type": "static",    "type6": "static",    "vlan_id": 1  },  "led": {    "brightness": 255,    "enabled": true  },  "locked": true,  "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",  "mesh": {    "enabled": false,    "group": 1,    "role": "base"  },  "modified_time": 0,  "name": "conference room",  "notes": "slightly off center",  "ntp_servers": [    "string"  ],  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "orientation": 45,  "poe_passthrough": false,  "pwr_config": {    "base": 2000,    "prefer_usb_over_wifi": false  },  "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",  "type": "ap",  "uplink_port_config": {    "dot1x": false,    "keep_wlans_up_if_down": false  },  "usb_config": {    "cacert": "string",    "channel": 3,    "enabled": true,    "host": "1.1.1.1",    "port": 0,    "type": "imagotag",    "verify_cert": true,    "vlan_id": 1  },  "vars": {    "RADIUS_IP1": "172.31.2.5",    "RADIUS_SECRET": "11s64632d"  },  "x": 53.5,  "y": 173.1}

getSiteDevice GET

Get Device Configuration

importSiteDevices POST

Import Information for Multiple Devices CSV format: ```csv mac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled 5c5b53010101,"AP 1",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,"guest, campus, vip",1,20,0,false,0,40,0,false,17,80,0,false ```