Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesBeacons

updateSiteBeacon

PUT
/api/v1/sites/{site_id}/beacons/{beacon_id}

Update Site Beacon

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
beacon_id*string
Formatuuid

Request Body

application/json

Request Body

Beacon configuration and placement data

eddystone_instance?string

Eddystone-UID instance (6 bytes) in hexstring format

eddystone_namespace?string

Eddystone-UID namespace (10 bytes) in hexstring format

eddystone_url?string

Eddystone-URL value broadcast by the beacon

ibeacon_major?|

iBeacon major value advertised by this beacon

Range1 <= value <= 65535
ibeacon_minor?|

iBeacon minor value advertised by this beacon

Range1 <= value <= 65535
ibeacon_uuid?|

iBeacon UUID advertised by this beacon

Formatuuid
mac?string

Optional beacon MAC address, currently used only to identify battery voltage

map_id?string

Map where the beacon is placed

Formatuuid
name?string

Display name of the beacon

power?integer

Beacon transmit power, in dBm

Range-12 <= value <= 100
Default-12
type?beacon_type

Beacon advertisement format used by this beacon. enum: eddystone-uid, eddystone-url, ibeacon.

Default"eddystone-uid"

Value in

  • "eddystone-uid"
  • "eddystone-url"
  • "ibeacon"
x?number

Horizontal map position of the beacon, in pixels

Formatdouble
y?number

Vertical map position of the beacon, in pixels

Formatdouble

Response Body

curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/beacons/000000ab-00ab-00ab-00ab-0000000000ab" \  -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}

deleteSiteBeacon DELETE

Delete Site Beacon

countSiteNacClientEvents GET

Count NAC client events for a site, optionally grouped by the `distinct` field and filtered by event type and time range. Use [Count Org NAC Client Events](/api/mist/orgs/orgs-clients/orgs-clients---nac/countOrgNacClientEvents) to count NAC client events across the organization.