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

runSiteApAutoplacement

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

This API is called to trigger auto placement for a map. For the auto placement feature to work, RTT-FTM data needs to be collected from the APs on the map.
This scan is disruptive, and users must be notified of service disruption during the auto placement process. 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 is set to false, the API attempts to start localization with existing data. If no data exists, the API attempts to start orchestration.
If force_collection is set to true, the API attempts to start orchestration.

Providing a list of devices is optional. If provided, autoplacement suggestions will be made only for the specified devices. If no list is provided, all APs associated with the map are considered by default.

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 options for validating or starting AP auto-placement

dryrun?boolean

Set to true to perform an invalid AP check and provide an estimated run time without enqueuing the run into the auto placement service.

Defaultfalse
force_collection?boolean
  • If force_collection==false: the API attempts to start localization with existing data.
  • If force_collection==true: maintenance the API attempts to start orchestration.
Defaultfalse
macs?array<string>

AP MAC addresses to include in the auto-placement run

override?boolean

Set to true to run auto placement even if there are invalid APs in the selected APs.

Defaultfalse

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/auto_placement" \  -H "Content-Type: application/json" \  -d '{}'

{  "devices": {    "00000000001": {      "valid": true    },    "00000000002": {      "valid": true    },    "00000000003": {      "valid": true    }  },  "estimated_runtime": 30,  "reason": "Map Already Enqueued",  "started": false,  "valid": true,  "wifi_interrupting": true}

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 |

deleteSiteApAutoplacement DELETE

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