getSiteApAutoplacement
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 |
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
uuiduuidResponse Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/auto_placement"{ "end_time": 1678900362, "start_time": 1678900062, "status": "done"}deleteSiteApAutoOrientation DELETE
This API is called to force stop auto placement for a given map
runSiteApAutoplacement POST
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.