Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Location

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
post/network-services/v1/ap-ranging-scans

Query parameters

site-idstring uuid required

The Site ID associated with the device commonly in UUID format.

The Site ID where the scan(s) were executed.

floor-idstring uuid required

The Floor ID associated with the device in UUID format.

The Floor ID where the scan(s) were executed.

dry-runboolean

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

Request body

scanStartTimestring 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

Scan is pending

idstring const

A unique system generated identifier for an ftm scan. This is a string representation of a uint64.

{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}
serialNumbersSerialNumberopen[]

List of serial numbers of the APs that will be performing the scan.

{"stackTrail":"components:schemas:Timestamp","oasType":"schema","type":"unknown","description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n"}
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).

errorMessagestring const

Error details in the case that a scan could not be started.