startSiteApAutoOrientation
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.
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
uuiduuidRequest Body
application/json
Request options for validating or starting AP auto-orientation
Set to true to perform an invalid AP check and provide an estimated run time without enqueuing the run into the auto orient service.
If force_collection==false, the API attempts to start auto orientation with existing BLE data.
If force_collection==true, the API attempts to start BLE orchestration.
falseAP MAC addresses to include in the auto-orient run
Set to true to run auto orient even if there are invalid APs in the selected APs.
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/auto_orient" \ -H "Content-Type: application/json" \ -d '{}'{ "devices": { "00000000001": { "reason": "Device meets the minimum requirements for auto orient", "valid": true }, "00000000002": { "reason": "Device meets the minimum requirements for auto orient", "valid": true }, "00000000003": { "reason": "Device meets the minimum requirements for auto orient", "valid": true } }, "estimated_runtime": 300, "reason": "Map has met the minimum requirements for auto orient", "valid": true, "wifi_interrupting": true}