SitesAuto Map Assignment

startSiteAutoMapAssignment

POST
/api/v1/sites/{site_id}/auto_map_assignment

Start the auto map assignment process for a site. The service automatically assigns APs to maps based on BLE ranging data and requires at least 3 APs with compatible firmware and model support for BLE.

Repeated POST requests while a site assignment is still running will be rejected.

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

Request Body

application/json

Request Body

Request options for validating or starting automatic AP map assignment

dryrun?boolean

If true, validates the site's APs without starting the map assignment process. Returns device validity and estimated runtime.

Defaultfalse
force_collection?boolean

If true, forces data collection via orchestration. If false, attempts to use existing BLE data first.

Defaultfalse

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/auto_map_assignment" \  -H "Content-Type: application/json" \  -d '{}'
{  "devices": {    "5c5b35000001": {      "reason": "Device meets the minimum requirements for auto map assignment",      "valid": true    },    "5c5b35000002": {      "reason": "Device meets the minimum requirements for auto map assignment",      "valid": true    },    "5c5b35000003": {      "reason": "Device meets the minimum requirements for auto map assignment",      "valid": true    }  },  "estimated_runtime": 300,  "reason": "Started auto map assignment",  "started": true,  "valid": true}