Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsDevice Profiles

updateOrgDeviceProfile

PUT
/api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id}

Update the AP, switch, or gateway configuration stored in an org-level device profile.

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
deviceprofile_id*string
Formatuuid

Request Body

application/json

Request Body

Device profile configuration for an AP, switch, or gateway

AP device profile configuration applied to APs at a site or organization

aeroscout?

Location integration defaults for AeroScout in this AP profile

airista?

Location integration defaults for Airista in this AP profile

ble_config?

Bluetooth Low Energy beacon and asset defaults in this AP profile

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
esl_config?

Electronic shelf label integration defaults in this AP profile

iot_config?

Digital and analog IoT pin defaults in this AP profile

ip_config?

Management IP addressing defaults in this AP profile

lacp_config?

Link aggregation defaults for supported AP Ethernet uplinks

led?

Indicator light behavior defaults in this AP profile

mesh?

Wireless mesh role and band defaults in this AP profile

mqtt_config?

MQTT broker publishing settings for this AP profile

name?|

Display name of the AP device profile

ntp_servers?array<string>

NTP servers configured by this AP profile

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 specified, this takes precedence over switch_config (deprecated)

pwr_config?

Power negotiation and peripheral power defaults in this AP profile

radio_config?

Radio configuration defaults in this AP profile

switch_config?
Deprecated

Deprecated AP switch configuration defaults in this profile

type*"ap"

Device type discriminator for AP device profiles

Value in

  • "ap"
uplink_port_config?

Authentication and failover defaults for AP uplink ports

usb_config?

Legacy USB integration defaults in this AP profile

uwb_config?

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

vars?

Variable values provided by this AP device profile

zigbee_config?

Zigbee radio and network defaults in this AP profile

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/deviceprofiles/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "aeroscout": {      "enabled": true,      "host": "aero.pvt.net"    },    "disable_eth1": true,    "disable_module": true,    "mesh": {      "enabled": true,      "group": 1,      "role": "base"    },    "name": "string",    "poe_passthrough": true,    "radio_config": {      "ant_gain_24": 0,      "ant_gain_5": 0,      "band_24": {        "allow_rrm_disable": true,        "antenna_mode": "default",        "bandwidth": 20,        "channel": 6,        "disabled": true,        "power": 8,        "preamble": "auto"      },      "band_24_usage": "24",      "band_5": {        "allow_rrm_disable": true,        "antenna_mode": "default",        "bandwidth": 20,        "channel": 50,        "disabled": true,        "power_max": 8,        "power_min": 15,        "preamble": "auto"      },      "scanning_enabled": true    },    "type": "ap"  }'

{  "aeroscout": {    "enabled": true,    "host": "string"  },  "created_time": 0,  "disable_eth1": true,  "disable_module": true,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "ip_config": {    "dns": [      "string"    ],    "dns_suffix": [      "string"    ],    "gateway": "192.168.0.1",    "gateway6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",    "ip": "192.168.0.1",    "ip6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",    "mtu": 1500,    "netmask": "192.168.0.1",    "netmask6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",    "type": "static",    "type6": "static",    "vlan_id": 1  },  "mesh": {    "enabled": true,    "group": 1,    "role": "base"  },  "modified_time": 0,  "name": "string",  "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "poe_passthrough": true,  "switch_config": {    "enabled": true,    "eth0": {      "port_vlan_id": 1,      "vlan_ids": [        1,        10      ]    },    "eth1": {      "port_vlan_id": 1,      "vlan_ids": [        10      ]    },    "eth2": {      "port_vlan_id": 1,      "vlan_ids": [        10      ]    },    "eth3": {      "port_vlan_id": 1,      "vlan_ids": [        10      ]    },    "module": {      "port_vlan_id": 1,      "vlan_ids": [        10      ]    },    "wds": {      "port_vlan_id": 1,      "vlan_ids": [        10      ]    }  },  "type": "ap",  "usb_config": {    "cacert": "string",    "enabled": true,    "host": "string",    "type": "imagotag",    "verify_cert": true  }}

deleteOrgDeviceProfile DELETE

Delete an org-level device profile and remove that reusable device configuration object from the organization.

unassignOrgDeviceProfile POST

Unassign Org Device Profile from Devices