UtilitiesLocation

sendSiteDevicesArbitraryBleBeacon

POST
/api/v1/sites/{site_id}/devices/send_ble_beacon

Send arbitrary BLE Beacon for a period of time

Note that only the devices that are connected will be restarted.

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

Request Body

application/json

Request to transmit an arbitrary BLE beacon frame from selected APs

beacon_frame?string

Raw BLE beacon frame payload to transmit

beacon_freq?integer

Transmission interval for the arbitrary BLE beacon frame

duration?integer

Number of seconds to continue sending the BLE beacon frame

Range1 <= value <= 60
macs?array<string>

AP MAC addresses of devices that should transmit the BLE beacon

map_ids?array<string>

Identifiers of maps whose APs should transmit the BLE beacon

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/send_ble_beacon" \  -H "Content-Type: application/json" \  -d '{    "beacon_frame": "68b329da9893e34099c7d8ad5cb9c940",    "beacon_freq": 100,    "duration": 10,    "macs": [      "5c5b35584a6f",      "5c5b350ea3b3"    ],    "map_ids": [      "845a23bf-bed9-e43c-4c86-6fa474be7ae5"    ]  }'
Empty