---
title: "Start an AP ranging scan (USE WITH CAUTION)"
method: POST
path: "/network-services/v1/ap-ranging-scans"
tags: ["Location"]
---

# Start an AP ranging scan (USE WITH CAUTION)

`POST /network-services/v1/ap-ranging-scans`

(USE WITH CAUTION) Will cause a wifi network outage! 

Starts an AP ranging scan for the given floor-id. 

AP ranging scans facilitate using automatic AP placement within the floorplan manager as it allows the system to collect inter-AP ranging information in a much shorter time frame.

During an AP ranging scan, all wifi client connectivity on the 5GHz radio will be disrupted for the system-calculated scan duration. When the scan completes, the network will automatically restore itself.

Only one scan can be active on a floor at any time.

The other pre-requisites for starting an AP ranging scan are:

1. APs on the given floor-id must be 'ftm-monitor' capable (ie. Running AOS firmware version 10.7.1 or greater)
2. APs on the given floor-id must be configured in the same regulatory domain (ie. configured with the same country code)
3. APs on the given floor must be synchronized with the same ntp server

## Query parameters

- `site-id` string, uuid, required — The Site ID associated with the device commonly in UUID format.
- `floor-id` string, uuid, required — The Floor ID associated with the device in UUID format.
- `dry-run` boolean

## Request body

- object — Scan parameters
  - `scanStartTime` string, const — Timestamp in milliseconds since epoch UTC indicating the start time of the ftm-monitor mode scan. All APs will stop servicing wifi clients on the 5GHz radio 2 minutes before this time and will start the scan at the specified time. The minimum value is 5 minutes from the current time, the default value is 10 minutes from the current time if this parameter is not provided.

## Response `201`

Scan is pending

- StartApRangingScanResponse — The result for the ftm scan start request.
  - `id` string, const — A unique system generated identifier for an ftm scan. This is a string representation of a uint64.
  - `scanStartTime` unknown
  - `serialNumbers` SerialNumberopen[] — List of serial numbers of the APs that will be performing the scan.
  - `estimatedCompletionTime` unknown
  - `result` 'SUCCESS' | 'SCAN_ALREADY_ACTIVE' | 'NOT_ENOUGH_APS' | 'REGULATORY_DOMAIN_MISMATCH' | 'NO_VALID_CHANNELS' | 'ERROR' | 'DRY_RUN', enum, required — The start scan request outcome. SUCCESS - Scan was successfully created and is now PENDING SCAN_ALREADY_ACTIVE - Scan already active on the given floor-id. Only one scan is allowed per floor at any given time. Scan cannot be started. NOT_ENOUGH_APS - There were not enough ftm-monitor enabled APs on the given floor-id. Scan cannot be started. REGULATORY_DOMAIN_MISMATCH - Not all APs are configured with the same country code. Scan cannot be started. NO_VALID_CHANNELS - Based on the user configured country code and channel selections, there are no available channels to run the ftm scan on. Scan cannot be started. ERROR - There was an error starting the scan (see errorMessage for details of the error).
  - `errorMessage` string, const — Error details in the case that a scan could not be started.

## Other responses

- `400` — Invalid input received.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `404` — No APs found to start scan.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.net/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arubanetworks/authorization/revisions/74c95058b11f/schema)