HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Start an AP ranging scan (USE WITH CAUTION)

(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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length ≤ 128

Site ID where the scan(s) were exectuted.

string
required
length ≤ 128

Floor ID where the scan(s) were exectuted.

boolean

If present, the scan will not be started, but the request will be validated.

Body Params
string
length ≤ 13

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.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json