SitesDevicesWireless
enableSiteDeviceZigbeeJoin
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).
Subscribe to Zigbee Join Events
WS /api-ws/v1/stream
{ "subscribe": "/sites/{site_id}/devices/{device_id}/zigbee_join"}Example output from ws stream
{ "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "19e73828-937f-05e6-f709-e29efdb0a82b", "zigbee_mac": "fd05eb86c04ac04a", "event_type": "associated", "detail": { "lqi": 180 } }}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
Format
uuiddevice_id*string
Format
uuidRequest Body
application/json
Request Body
Request body for temporarily allowing Zigbee end-device joins
duration?integer
Number of seconds to permit new Zigbee end-device joins; range is 60-600
Range
60 <= value <= 600Default
600Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/zigbee_join" \ -H "Content-Type: application/json" \ -d '{ "duration": 600 }'{ "session_id": "19e73828-937f-05e6-f709-e29efdb0a82b"}