SitesAsset Filters

createSiteAssetFilter

POST
/api/v1/sites/{site_id}/assetfilters

Create Site Asset Filter

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 Body

BLE asset filter definition; all specified criteria must match

aeroscout_forwarding?boolean

Whether matching BLE advertisements are forwarded to AES when aeroscout is enabled on the device

Defaultfalse
ap_mac?string

Access point MAC address that must observe the BLE asset

beam?integer

BLE beam number used to filter asset observations

disabled?boolean

Whether the asset filter is disabled

Defaultfalse
eddystone_uid_namespace?string

Eddystone uid namespace used to filter assets

eddystone_url?string

Eddystone url used to filter assets

ibeacon_major?|

Major value from the iBeacon advertisement that assets must match

Range1 <= value <= 65535
ibeacon_uuid?|

UUID from the iBeacon advertisement that assets must match

Formatuuid
mfg_company_id?integer

BLE manufacturing-specific company-id used to filter assets

mqtt_topic?string

If set, matching BLE advertisements are forwarded to this MQTT topic when MQTT publishing is enabled

name*string

Display name for this BLE asset filter

rssi?integer

Signal strength threshold used to filter BLE asset observations

service_uuid?string

BLE service data uuid used to filter assets

Formatuuid

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/assetfilters" \  -H "Content-Type: application/json" \  -d '{    "name": "Visitor Tags"  }'
{  "created_time": 0,  "disabled": true,  "eddystone_uid_namespace": "string",  "eddystone_url": "string",  "for_site": true,  "ibeacon_major": 1,  "ibeacon_uuid": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "mfg_company_id": 0,  "modified_time": 0,  "mqtt_topic": "xxxxx",  "name": "string",  "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"}