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

deleteSiteApAutoOrientation

DELETE
/api/v1/sites/{site_id}/maps/{map_id}/auto_orient

This API is called to force stop auto placement for a given map

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

map_id*string
Formatuuid
site_id*string
Formatuuid

Response Body

curl -X DELETE "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/auto_orient"
Empty

startSiteApAutoOrientation POST

This API is called to trigger a map for auto orient. For auto orient feature to work, BLE data needs to be collected from the APs on the map. This precess is not disruptive unlike FTM collection. Repeated POST requests to this endpoint while a map is still running will be rejected. `force_collection` is set to `false` by default. If `force_collection`==`false`, the API attempts to start orientation with existing data. If no data exists, the API attempts to start collecting orientation data. If `force_collection`==`true`, the API attempts to start collecting orientation data. Providing a list of device macs is optional. If provided, auto orientation suggestions will be made only for the specified devices. If no list is provided, all APs associated with the map are considered by default.

getSiteApAutoplacement GET

This API is called to view the current status of auto placement for a given map. #### Status Descriptions | Status | Description | | --- | --- | | `pending` | Autoplacement has not been requested for this map | | `inprogress` | Autoplacement is currently processing | | `done` | The autoplacement process has completed | | `data_needed` | Additional position data is required for autoplacement. Users should verify the requested anchor APs have a position on the map | | `invalid_model` | Autoplacement is not supported on the model of the APs on the map | | `invalid_version` | Autoplacement is not supported with the APs current firmware version | | `error` | There was an error in the autoplacement process |