Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesMapsAuto-placement

acceptSiteApLocalizationData

POST
/api/v1/sites/{site_id}/maps/{map_id}/apply_autoplacement

Accept the cached autoplacement and auto-orientation values of a map or subset of APs on a map. Any APs that have autoplacement values are stored in cache for up to 7 days while awaiting acceptance.

Accepting the autoplacement values overwrites the existing X, Y, and orientation of the accepted APs with their cached autoplacement values.

Once a decision to accept is made, or the 7-day time-to-live (TTL) expires, the cached values are deleted.

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

Request Body

application/json

Request Body

Request body to apply or clear cached autoplacement or auto-orientation values for a map or subset of APs

for?autoplacement_localization_selector_for

The selector to choose auto placement or auto orientation. enum: orientation, placement

Default"placement"

Value in

  • "orientation"
  • "placement"
macs?array<string>

List of AP MAC addresses to apply the action to. If omitted, the action applies to all APs on the map

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/apply_autoplacement" \  -H "Content-Type: application/json" \  -d '{    "for": "placement",    "macs": [      "5c5b35000001"    ]  }'
Empty

startSiteMapsAutoGeofence POST

The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as "geofences". This API processes all maps for a given SiteId. The maps must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected.

clearSiteApAutoOrient POST

This API is used to destroy the autoorientations of a map or subset of APs on a map.