createSiteBeacon
Create Site Beacon
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
uuidRequest Body
application/json
Request Body
Beacon configuration and placement data
Eddystone-UID instance (6 bytes) in hexstring format
Eddystone-UID namespace (10 bytes) in hexstring format
Eddystone-URL value broadcast by the beacon
iBeacon major value advertised by this beacon
1 <= value <= 65535iBeacon minor value advertised by this beacon
1 <= value <= 65535iBeacon UUID advertised by this beacon
uuidOptional beacon MAC address, currently used only to identify battery voltage
Map where the beacon is placed
uuidDisplay name of the beacon
Beacon transmit power, in dBm
-12 <= value <= 100-12Beacon advertisement format used by this beacon. enum: eddystone-uid, eddystone-url, ibeacon.
"eddystone-uid"Value in
- "eddystone-uid"
- "eddystone-url"
- "ibeacon"
Horizontal map position of the beacon, in pixels
doubleVertical map position of the beacon, in pixels
doubleResponse Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/beacons" \ -H "Content-Type: application/json" \ -d '{ "eddystone_instance": "string", "eddystone_namespace": "string", "eddystone_url": "string", "ibeacon_major": 1, "ibeacon_minor": 1, "ibeacon_uuid": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "mac": "string", "name": "string", "power": 0, "type": "eddystone-uid", "x": 0, "y": 0 }'{ "created_time": 0, "eddystone_instance": "string", "eddystone_namespace": "string", "eddystone_url": "string", "ibeacon_major": 1, "ibeacon_minor": 1, "ibeacon_uuid": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "mac": "string", "map_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "modified_time": 0, "name": "string", "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "power": 0, "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "type": "eddystone-uid", "x": 0, "y": 0}