Jump to Content
Home
Guides
API Reference
Guides
MRT API
Configuration API
AOS 8
AOS-CX
Central
New Central
New Central - Configuration API
ClearPass Policy Manager
User Experience Insight
Fabric Composer
EdgeConnect SD-WAN
GitHub
Airheads Developer Community
API Reference
GitHub
Airheads Developer Community
New Central
API Reference
Guides
MRT API
Configuration API
Insights
JUMP TO
Authorization
Generate Access Token
post
Monitoring
Access Points
Get a list of Access Points
get
Get a list of Access Points
get
Get a list of Radios
get
Get a list of BSSIDs
get
Get a list of WLANs
get
Get a list of Swarms
get
Get high wireless bandwidth usage Access Points
get
Get high wired bandwidth usage Access Points
get
Get high total bandwidth usage Access Points
get
Get an Access Point details
get
Get throughput trend of an Access Point.
get
Get CPU utilization information for an Access Point
get
Get memory utilization information for an Access Point
get
Get power consumption information for an Access Point
get
Get a list of Access Point radios
get
Get Access Point Radio throughput trend.
get
Get channel utilization information for a radio
get
Get channel quality information for a radio
get
Get noise floor information for a radio
get
Get transmission information for a radio
get
Get a list of Access Point ports
get
Get Access Point Port throughput trend.
get
Get Access Point Port Frame Trends
get
Get Access Point Port CRC Errors
get
Get Access Point Port Collision Error
get
Get a list of Access Point Tunnels
get
Get an Access Point Tunnel details
get
Get throughput trend of an Access Point Tunnel.
get
Get packet loss trend of an Access Point Tunnel.
get
Get MOS score trend of an Access Point Tunnel.
get
Get jitter trend of an Access Point Tunnel.
get
Get latency trend of an Access Point Tunnel.
get
Get a list of Access Point WLANs
get
Get the throughput trend for a WLAN of an Access Point.
get
Get a specific WLAN by name
get
Get the throughput trend for a WLAN.
get
Get a Swarm details
get
Get high wireless bandwidth usage Access Points
get
Get high wired bandwidth usage Access Points
get
Get high total bandwidth usage Access Points
get
Get a list of Access Points
get
Get a list of Radios
get
Get an Access Point details
get
Get channel utilization information for a radio
get
Get channel quality information for a radio
get
Get noise floor information for a radio
get
Get transmission information for a radio
get
Get CPU utilization information for an Access Point
get
Get memory utilization information for an Access Point
get
Get power consumption information for an Access Point
get
Get Access Point Port Frame Trends
get
Get Access Point Port CRC Errors
get
Get Access Point Port Collision Error
get
Get throughput trend of an Access Point.
get
Get Access Point Radio throughput trend.
get
Get Access Point Port throughput trend.
get
Get the throughput trend for a WLAN of an Access Point.
get
Get a list of Access Point radios
get
Get a list of Access Point ports
get
Get a list of WLANs
get
Get a specific WLAN by name
get
Get a list of Access Point WLANs
get
Get a list of Access Point Tunnels
get
Get an Access Point Tunnel details
get
Get throughput trend of an Access Point Tunnel.
get
Get packet loss trend of an Access Point Tunnel.
get
Get jitter trend of an Access Point Tunnel.
get
Get latency trend of an Access Point Tunnel.
get
Get MOS score trend of an Access Point Tunnel.
get
Get the throughput trend for a WLAN.
get
Get a list of Swarms
get
Get a Swarm details
get
Application Visibility
Get applications accessed in a site
get
Get applications accessed in a site
get
Client Onboarding
Get onboarding score
get
Clients
List Unified Clients
get
Get Clients Trend
get
Get Top N Clients By Usage
get
Get Client Details
get
Get Wireless Client Mobility Details
get
List all clients
get
Get client trends
get
Get Top N Clients By Usage
get
get Client Details
get
Get wireless client mobility details
get
Devices
Get a list of devices
get
Update device notes by serial number
patch
Delete a device by serial number
del
Get a device inventory list
get
Get a list of devices
get
Update device notes by serial number
patch
Delete a device by serial number
del
Get a device inventory list
get
Firewall Session
Get blocked firewall session logs
get
Get client firewall session logs
get
Get clients list
get
Get blocked firewall session logs
get
Get client firewall session logs
get
Get clients list
get
FloorPlan
Site devices summary
get
Place devices over the FloorMap
post
Retrieves placed devices over the FloorMap
get
Remove devices from the FloorMap
post
Assign/Unassign devices to the FloorPlan
post
Retrieves assigned devices
get
Place planned devices
post
Retrieves placed (planned) devices
get
Remove planned devices on the FloorMap
del
Retrieves device specification for all models
get
Create New Floor
post
Remove floor from a building
del
Retrieve FloorMap information
get
Update FloorMap
put
Scale FloorMap
post
Retrieve FloorMap Image
get
Update Floor Image
put
Retrieve building information
get
Remove Building
del
Update Building
put
Import FloorPlans using zip file
post
Retrieve Import Status
get
Retrieve Wall Types
get
Create Wall Types
post
Update Wall Types
put
Delete Wall Types.
del
Retrieve Walls
get
Create Wall
post
Update Walls.
put
Delete Walls.
del
Retrieves Zones
get
Create zone
post
Update zones
put
Delete zones
del
Site devices summary
get
Place devices over the FloorPlan
post
Retrieves placed devices over the FloorPlan
get
Remove devices from the FloorPlan
post
Assign/Unassign devices to the FloorPlan
post
Retrieves assigned devices
get
Place planned devices
post
Retrieves placed (planned) devices
get
Remove planned devices on the FloorPlan
del
Retrieves All Real device information
get
Create New Floor
post
Remove floor from a building
del
Retrieve FloorMap information
get
Update FloorMap
put
Scale FloorMap
post
Retrieve FloorMap Image
get
Update Floor Image
put
Get RasterImage (Deprecated)
get
Retrieve building information
get
Remove Building
del
Update Building
put
Import FloorPlans using zip file
post
Retrieve Import Status
get
Retrieve Wall Types
get
Create Wall Types
post
Update Wall Types
put
Delete Wall Types.
del
Retrieve Walls
get
Create Wall
post
Update Walls.
put
Delete Walls.
del
Retrieves Zones
get
Create zone
post
Update zones
put
Delete zones
del
Retrieve signal strength heatmap.
get
Retrieve channel occupancy heatmap.
get
Gateways
List Gateways
get
Gateway Details
get
List Gateway tunnels
get
Gateway tunnel detail
get
List Gateway wired interfaces
get
List Gateway wired interfaces
get
List Gateway WAN interfaces
get
Get details of gateway uplink
get
List Gateways
get
Gateway Details
get
Gateway cluster vlan mismatch summary
get
Gateway cluster connectivity graph information
get
Gateway vlan detail
get
List Gateway Cluster members
get
Gateway tunnel detail
get
List Gateway ports
get
Gateway port detail
get
List Gateway Cluster tunnels
get
List Gateway vlans
get
List Gateway tunnels
get
List Gateway uplinks
get
Get gateway cpu utilization trend
get
Get gateway memory utilization trend
get
Get gateway tunnel throughput trend
get
Get gateway tunnel status trend
get
Get cluster capacity trend
get
Get cluster member capacity trend
get
Get gateway port throughput trend
get
Get summary of cluster tunnel health
get
Get summary of cluster tunnel status
get
Get summary of gateway LAN tunnels health
get
Get gateway WAN availability trend
get
Get gateway VPN availability trend
get
Get gateway port frames trend
get
Get gateway port frames errors trend
get
Get gateway port frames packets trend
get
Get gateway tunnel dropped packets trend
get
Get summary of gateway WAN tunnel health
get
Get details of gateway uplink
get
Get gateway uplink throughput trend
get
Get gateway WAN compression trends for an uplink
get
List gateway uplink probes
get
Get WAN availability trends of gateway uplink
get
Get VPN availability trends of gateway uplink
get
Get gateway hardware temperature trends
get
Get DHCP pools configured on the gateway
get
Get DHCP leases present in the DHCP pool
get
List Gateways
get
Gateway Details
get
Gateway cluster leader details
get
Gateway cluster vlan mismatch summary
get
Gateway cluster connectivity graph information
get
Gateway vlan detail
get
List Gateway Cluster members
get
Gateway tunnel detail
get
List Gateway wired interfaces
get
List Gateway Cluster tunnels
get
List Gateway vlans
get
List Gateway LAN tunnels
get
List Gateway WAN interfaces
get
Get gateway cpu utilization trend
get
Get gateway memory utilization trend
get
Get gateway LAN tunnel throughput trend
get
Get gateway WAN tunnel throughput trend
get
Get gateway LAN tunnel status trend
get
Get gateway WAN tunnel status trend
get
Get cluster capacity trend
get
Get cluster member capacity trend
get
Get gateway interface throughput trend
get
Get summary of cluster tunnel health
get
Get summary of cluster tunnel status
get
Get summary of gateway tunnel health
get
Get gateway WAN availability trend
get
Get gateway VPN availability trend
get
Get gateway port frames trend
get
Get gateway port frames errors trend
get
Get gateway port frames packets trend
get
Get gateway tunnel dropped packets trend
get
Get gateway tunnel dropped packets trend
get
List Gateway WAN tunnels
get
Gateway WAN tunnel detail
get
Get summary of gateway WAN tunnel health
get
Get details of gateway uplink
get
Get gateway uplink throughput trend
get
Get gateway WAN compression trends for an uplink
get
List gateway uplink's probes
get
List gateway uplink performance trends for the selected probe
get
Get WAN availability trends of gateway uplink
get
Get VPN availability trends of gateway uplink
get
Get gateway hardware temperature trends
get
Get DHCP pools configured on the gateway
get
Get DHCP leases present in the DHCP pool
get
Get the aggregated bandwidth usage of the gateway uplink
get
Get the aggregated bandwidth usage of the gateway port.
get
Get the aggregated bandwidth usage of the gateway LAN tunnel.
get
Get gateway uplink modem stats data
get
Get the aggregated bandwidth usage of the gateway WAN tunnel.
get
IDPS
Get a list of IDPS threats.
get
Get an IDPS threat's details
get
Live Upgrade
Get all AP upgrades
get
Get all Gateway upgrades
get
Get device upgrades
get
Site Health
List of sites with health overview
get
Site information
get
List of sites with device health
get
Device health overview
get
List of sites with client health
get
Client health overview
get
List of sites with health overview
get
Site information
get
List of sites with device health
get
Device health overview
get
List of sites with client health
get
Client health overview
get
Switch
Returns the list of switches associated to a customer, based on the query parameters provided.
get
Returns the switch details for the given serial or stack id.
get
Returns stack member details for the given stack-id or conductor serial.
get
Returns hardware details for the given serial or stack id.
get
Returns lag summary details for the given serial or stack id.
get
Returns interface details for the given serial or stack id.
get
Returns vlans details for the given serial or stack id.
get
Returns Top-n interface trends for the tenant-id and given site.
get
Returns interface trends for the given serial and site.
get
Returns hardware trends for the given serial and site.
get
Returns interface poe for the given serial and site.
get
Returns VSX details for a specified switch serial number.
get
Returns the list of switches associated to a customer, based on the query parameters provided.
get
Returns switch details for the given serial or stack id.
get
Returns stack member details for the given stack id or conductor serial.
get
Returns hardware details for the given serial or stack id.
get
Returns lag summary details for the given serial or stack id.
get
Returns interface details for the given serial or stack id.
get
Returns vlans details for the given serial or stack id.
get
Returns Top-n interface trends for the tenant-id and given site.
get
Returns interface trends for the given serial and site.
get
Returns hardware trends for the given serial and site.
get
Returns interface poe for the given serial and site.
get
Topology
Returns topology details for the given site.
get
Returns details for an unmanaged device of a given site.
get
Returns isolated devices for the given site.
get
Returns details of neighbour devices of a given serial for a given site.
get
Returns topology details for the given site.
get
Returns details for an unmanaged device of a given site.
get
Returns isolated devices for the given site.
get
Returns details of neighbor devices for a given serial number.
get
MSP
MSP
Get all MSP tenants information.
get
Get all MSP tenants information.
get
Notifications
Alerts
List all alerts
get
Clear alerts
post
Defer alerts
post
Set alerts to active
post
Set alert priority
post
Get alerts classification
get
Get async operation status
get
List all alerts
get
Insights
Reporting
Reporting
List Reports
get
Update Report
put
List Report Runs
get
Health of Reporting service
get
List Reports
get
Create Report
post
Update Report
put
Delete Report
del
List Report Runs
get
Delete Report Run
del
Get Report Download Link
get
Get Reports Metadata
get
Services
Audit Trail Information
Get Audit log based on the audit id.
get
Get audit logs belonging to the tenant.
get
Firmware Management
Get device list with firmware details
get
Get device list with firmware details
get
Location
List AP ranging scans
get
Get scan resource
get
List devices with location information
get
Get location resource
get
Get device location details
get
Get a list of Asset Tags
get
Get Asset Tag details
get
Update Asset Tag metadata
put
Create Asset Tag metadata
post
Remove Asset Tag metadata
del
Start an AP ranging scan (USE WITH CAUTION)
post
List AP ranging scans
get
Get scan resource
get
Stop a scan
del
List devices with location information
get
Get location resource
get
Get device location details
get
Set device coordinates
post
Delete device coordinates
del
Get locations of Wi-Fi clients
get
Get a list of Asset Tags
get
Get an Asset Tag's details
get
Update Asset Tag metadata
put
Create Asset Tag metadata
post
Remove Asset Tag metadata
del
Start an AP ranging scan (USE WITH CAUTION)
post
List AP ranging scans
get
Get scan resource
get
Stop a scan
del
List devices with location information
get
Get location resource
get
Get device location details
get
Set device coordinates
post
Delete device coordinates
del
Get locations of Wi-Fi clients
get
Location Analytics
Get all the trends of a client for a tenant or a site for a given time range.
get
Get the insights for each site of a tenant for a given time range.
get
Get all the trends of a client for a tenant or a site for a given time range.
get
Get the insights for each site of a tenant for a given time range.
get
Webhooks
List all Webhooks
get
Create a Webhook
post
Get a Webhook details by ID
get
Update a Webhook by ID
put
Patch a Webhook by ID
patch
Delete a Webhook by ID
del
Rotate HMAC key for a Webhook by ID
post
List all Webhooks
get
Create a Webhook
post
Get a Webhook details by ID
get
Update a Webhook by ID
put
Patch a Webhook by ID
patch
Delete a Webhook by ID
del
Rotate HMAC key for a Webhook by ID
post
Troubleshooting
AOS-S Switches
Initiate a Ping test on a AOS-S Switch
post
Get AOS-S Switch Ping test status and results
get
Initiate a Traceroute test on a AOS-S Switch
post
Get AOS-S Switch Traceroute test status and results
get
Initiate a Poe Bounce test on a AOS-S Switch
post
Get AOS-S Switch Poe Bounce test status and results
get
Initiate a Port Bounce test on a AOS-S Switch
post
Get AOS-S Switch Port Bounce test status and results
get
Initiate a Cable Test on a AOS-S Switch
post
Get AOS-S Switch Cable Test status and results
get
Initiate a Get Arp Table test on a AOS-S Switch
post
Get AOS-S Switch Get Arp Table test status and results
get
List 'show' commands (AOS-S - top commands)
get
Run 'show' commands (AOS-S)
post
Get 'show' commands status/result (AOS-S)
get
Reboot an AOS-S Switch
post
Locate an AOS-S Switch
post
List active async tasks for an AOS-S Switch
get
Initiate a Ping test on a AOS-S Switch
post
Get AOS-S Switch Ping test status and results
get
Initiate a Traceroute test on a AOS-S Switch
post
Get AOS-S Switch Traceroute test status and results
get
Initiate a Poe Bounce test on a AOS-S Switch
post
Get AOS-S Switch Poe Bounce test status and results
get
Initiate a Port Bounce test on a AOS-S Switch
post
Get AOS-S Switch Port Bounce test status and results
get
Initiate a Cable Test on a AOS-S Switch
post
Get AOS-S Switch Cable Test status and results
get
Initiate a Get Arp Table test on a AOS-S Switch
post
Get AOS-S Switch Get Arp Table test status and results
get
List 'show' commands (AOS-S - top commands)
get
Run 'show' commands (AOS-S)
post
Get 'show' commands status/result (AOS-S)
get
Reboot a AOS-S Switch
post
Locate a AOS-S Switch
post
List active async tasks for an AOS-S Switch
get
Access Points
Initiate a Ping test on an AP
post
Get AP Ping test status and results
get
Initiate a Traceroute test on an AP
post
Get AP Traceroute test status and results
get
Initiate a Speedtest on an AP
post
Get AP Speedtest status and results
get
Initiate an HTTP test on an AP
post
Get AP HTTP test status and results
get
Initiate an HTTPS test on an AP
post
Get AP HTTPS test status and results
get
Initiate a TCP test on an AP
post
Get AP TCP test status and results
get
Initiate a Get Arp Table test on an AP
post
Get AP Get Arp Table test status and results
get
Initiate an Nslookup test on an AP
post
Get AP Nslookup test status and results
get
Initiate an AAA test on an AP
post
Get AP AAA test status and results
get
List 'show' commands (AP - top commands)
get
Run 'show' commands (AP)
post
Get 'show' commands status/result (AP)
get
Reboot an Access Point
post
Reboot an AP Swarm
post
Locate an Access Point
post
Disconnect all users from an Access Point
post
Disconnect a specific user by MAC address from an Access Point
post
Disconnect all users from a specific network (SSID) on an Access Point
post
List active async tasks for an AP
get
Initiate a Ping test on a AP
post
Get AP Ping test status and results
get
Initiate a Traceroute test on a AP
post
Get AP Traceroute test status and results
get
Initiate a Speedtest on a AP
post
Get AP Speedtest status and results
get
Initiate a Http test on a AP
post
Get AP Http test status and results
get
Initiate a Https test on a AP
post
Get AP Https test status and results
get
Initiate a Tcp test on a AP
post
Get AP Tcp test status and results
get
Initiate a Get Arp Table test on a AP
post
Get AP Get Arp Table test status and results
get
Initiate an Nslookup test on a AP
post
Get AP Nslookup test status and results
get
Initiate an AAA test on an AP
post
Get AP AAA test status and results
get
List 'show' commands (AP - top commands)
get
Run 'show' commands (AP)
post
Get 'show' commands status/result (AP)
get
Reboot an Access Point
post
Reboot an AP Swarm
post
Locate an Access Point
post
Disconnect all users from an Access Point
post
Disconnect a specific user by MAC address from an Access Point
post
Disconnect all users from a specific network (SSID) on an Access Point
post
List active async tasks for an AP
get
CX Switches
Initiate a Ping test on a CX Switch
post
Get CX Switch Ping test status and results
get
Initiate a Traceroute test on a CX Switch
post
Get CX Switch Traceroute test status and results
get
Initiate a Poe Bounce test on a CX Switch
post
Get CX Switch Poe Bounce test status and results
get
Initiate a Port Bounce test on a CX Switch
post
Get CX Switch Port Bounce test status and results
get
Initiate a Cable Test on a CX Switch
post
Get CX Switch Cable Test status and results
get
Initiate a Http test on a CX Switch
post
Get CX Switch Http test status and results
get
Initiate a Aaa test on a CX Switch
post
Get CX Switch Aaa test status and results
get
List 'show' commands (CX - strict supported list)
get
Run 'show' commands (CX)
post
Get 'show' commands status/result (CX)
get
Locate a CX Switch
post
Reboot a CX Switch
post
List active async tasks for a CX Switch
get
Initiate a Ping test on a CX Switch
post
Get CX Switch Ping test status and results
get
Initiate a Traceroute test on a CX Switch
post
Get CX Switch Traceroute test status and results
get
Initiate a Poe Bounce test on a CX Switch
post
Get CX Switch Poe Bounce test status and results
get
Initiate a Port Bounce test on a CX Switch
post
Get CX Switch Port Bounce test status and results
get
Initiate a Cable Test on a CX Switch
post
Get CX Switch Cable Test status and results
get
Initiate a Http test on a CX Switch
post
Get CX Switch Http test status and results
get
Initiate a Aaa test on a CX Switch
post
Get CX Switch Aaa test status and results
get
List 'show' commands (CX - strict supported list)
get
Run 'show' commands (CX)
post
Get 'show' commands status/result (CX)
get
Locate a CX Switch
post
Reboot a CX Switch
post
List active async tasks for a CX Switch
get
Events
List Events
get
Get Event Extra Attributes
get
Get Event Filters
get
List Events
get
Get Event Extra Attributes
get
Get Event Filters
get
Gateways
Initiate a Ping test on a Gateway
post
Get Gateway Ping test status and results
get
Run PingSweep (Gateway)
post
Get PingSweep status/result (Gateway)
get
Initiate a Traceroute test on a Gateway
post
Get Gateway Traceroute test status and results
get
Initiate a Poe Bounce test on a Gateway
post
Get Gateway Poe Bounce test status and results
get
Initiate a Port Bounce test on a Gateway
post
Get Gateway Port Bounce test status and results
get
Initiate a Iperf test on a Gateway
post
Get Gateway Iperf test status and results
get
Initiate a Http test on a Gateway
post
Get Gateway Http test status and results
get
Initiate a Https test on a Gateway
post
Get Gateway Https test status and results
get
Initiate a Get Arp Table test on a Gateway
post
Get Gateway Get Arp Table test status and results
get
List 'show' commands (Gateway - top commands)
get
Run 'show' commands (Gateway)
post
Get 'show' commands status/result (Gateway)
get
Reboot a Gateway
post
Disconnect all clients from a Gateway
post
Disconnect a specific client by MAC address from a Gateway
post
Halt a Gateway
post
List active async tasks for a Gateway
get
Initiate a Ping test on a Gateway
post
Get Gateway Ping test status and results
get
Run PingSweep (Gateway)
post
Get PingSweep status/result (Gateway)
get
Initiate a Traceroute test on a Gateway
post
Get Gateway Traceroute test status and results
get
Initiate a Poe Bounce test on a Gateway
post
Get Gateway Poe Bounce test status and results
get
Initiate a Port Bounce test on a Gateway
post
Get Gateway Port Bounce test status and results
get
Initiate a Iperf test on a Gateway
post
Get Gateway Iperf test status and results
get
Initiate a Http test on a Gateway
post
Get Gateway Http test status and results
get
Initiate a Https test on a Gateway
post
Get Gateway Https test status and results
get
Initiate a Get Arp Table test on a Gateway
post
Get Gateway Get Arp Table test status and results
get
List 'show' commands (Gateway - top commands)
get
Run 'show' commands (Gateway)
post
Get 'show' commands status/result (Gateway)
get
Reboot a Gateway
post
Disconnect all clients from a Gateway
post
Disconnect a specific client by MAC address from a Gateway
post
Halt a Gateway
post
List active async tasks for a Gateway
get
Powered by
Insights
