initiateSiteAnalyzeSpectrum
Initiate a spectrum analysis for a site
The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.
Subscribe to Device Command outputs
WS /api-ws/v1/stream
json { "subscribe": "/sites/{site_id}/analyze_spectrum" }
Example output from ws stream
{ "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/analyze_spectrum", "data": { "session": "session_id", "fft_samples": [ { "frequency": 2437.0, "rssi / signal ?": -93 }, ... ], "channel_usage": [ { "channel": 36, "noise": -78, "wifi": 0.13, "non_wifi": 0.08 }, ... ] }}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
uuidRequest Body
application/json
Request Body
Request parameters for starting AP spectrum analysis at a site
Radio band to scan during spectrum analysis. enum: 24, 5, 6.
Value in
- "24"
- "5"
- "6"
Optional list of channels to scan. If not specified, all supported channels will be scanned
Optional device-generated UUID of the AP that is performing spectrum analysis. Required when device_ids is not provided.
uuidOptional device-generated UUIDs of APs to scan. When provided, these take precedence over device_id; maximum 5 devices.
1 <= items <= 5Length of the spectrum analysis run, in seconds
60 <= value <= 3600600Output format for the spectrum analysis results. enum: json, stream.
"json"Value in
- "json"
- "stream"
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/analyze_spectrum" \ -H "Content-Type: application/json" \ -d '{ "band": "5", "channels": [ 36, 40, 44, 48 ], "device_id": "00000000-0000-0000-1000-5c5b35bd76bb", "duration": 600, "format": "stream" }'{ "band": "24", "channels": [ 0 ], "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940", "device_ids": [ "743d709b-361e-4f32-8914-0bf36add9bdd" ], "duration": 0, "format": "json", "invalid_device_ids": { "property1": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "property2": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] }, "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82", "started_time": 0, "width": 0}