{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Devices - Wireless API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Devices - Wireless", "type": "folder" }, "items": [ { "info": { "name": "listSiteDeviceRadioChannels", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/ap_channels", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "country_code", "value": "US", "type": "query", "description": "Country code for the site (for AP config generation), in [two-character](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" } ] }, "docs": "Get a list of allowed channels (per channel width)" }, { "info": { "name": "getSiteDeviceIotPort", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/iot", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" } ] }, "docs": "Returns the current state of each enabled IoT pin configured as an output." }, { "info": { "name": "setSiteDeviceIotPort", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/iot", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note**: For each IoT pin referenced:\n * The pin must be enabled using the Device `iot_config` API\n * The pin must support the output direction" }, { "info": { "name": "enableSiteDeviceZigbeeJoin", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/zigbee_join", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "device_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allow Zigbee end devices to join the network for a configurable duration. After the duration expires, new joins will be blocked (unless `allow_join`==`always` is configured on the device).\n\n#### Subscribe to Zigbee Join Events\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/zigbee_join\"\n}\n```\n##### Example output from ws stream\n```json\n{\n \"event\": \"data\",\n \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b35" } ] } ], "bundled": true }