Introduction
Authentication and Authorization
API Request Components
Response Codes
Versioning
AccessControlManager
get
Retrieve access control information
put
Update access control information
post
Create access control list
del
Remove access control list
NSightManager
get
Get configuration of NSight server
put
Update configuration of NSight server
AccessPointManager
get
Get list of all access points
get
Get filtered list of all access points
get
Get filtered list of all access points
get
Return the columns list for /v1/aps/query and /v1/aps/query/visualize
get
Get service IDs that are assigned to the primary BSSID. Removing these services can cause a radio reset.
get
Get access point adoption rules. XCA 4.56 uses the new resource path "/v1/devices/adoptionrules" path. (Deprecated)
put
Update access point adoption rules. XCA 4.56 uses the new resource path "/v1/devices/adoptionrules" path. (Deprecated)
get
Get access point balance mode
put
Update the access point balance mode
post
Create new access point
get
Get access point with default values
get
Get hardware type and display names
get
Get hardware type and model names
del
Delete list of access points by their serial numbers
put
Update configuration for a group of access points
post
Generate CSR
post
Apply certificate to APs. (Provide AP signed certificate tar).
put
Reset certificate to default (removal)
get
Get AP certificate information
get
Get access point platform names
put
Reboot a list of access points
put
List of access points released to ExtremeCloud IQ
put
Assign a list of access points to a site and device group
put
Set affinity for a list of access points
post
Clone access point configuration
get
Get global access point registration information
put
Update global access point registration information
put
Update access point state
put
Upgrade access point software version
put
Get list of software image versions
put
Update access point software by specific image name
get
Get access point upgrade image files
put
Schedule upgrade for a set of access points
get
Get reports that are based on the widget list for all access points
get
Get available widgets for the AP report (/v1/aps/{apSerialNumber}/report)
put
Get AP stats plus widgets data (use /v1/aps/report/widgets to get the available widgets)
get
Get reports that are based on the widgetList for a given access point
get
Get access point by serial number
put
Update access point configuration
del
Delete access point by serial number
get
Get access point antenna information by serial number
get
Get trace file
put
Copy access point configuration to the default configuration
put
Enable access point logs download
put
Enable access point real-time capture
put
Reboot access point by serial number
put
Locate access point by serial number
put
Enable access point reset during next check-in
put
Update access point state by serial number
get
Get access point traces download URL
put
Upgrade access point software by AP image version
get
Get access point stations
get
Get access point supported environments
get
Get a list of station locations for an AP by serial number
get
Get access point lldp info per port
get
Get AP alarms list
get
Get Smart RF reports for a given access point
get
Get reports that are based on the widgetList for all access points in a site
put
Set AP log level for a list of access points
ConcentratorManager
get
Get list of GRE / IPSec concentrators
post
Create concentrator instance
get
Get concentrator by ID
put
Update concentrator configuration
del
Delete concentrator by ID
get
Get concentrator with default values
get
Get concentrator name to ID map
AdministratorManager
get
Get a list of administrators for a customer
post
Create an administrator for a customer
put
Change an administrator's password
get
Get an administrator by user ID
put
Update an administrator for a customer
del
Delete an administrator for a customer
put
Update an administrator by user ID
post
Send a refresh token and obtain a new OAuth 2 access token
post
Obtain an access token using Oauth2 authorization grant type:password
del
Delete an access token
post
Validates OAuth2 access token. Please refer to (https://tools.ietf.org/html/rfc7662) for more details.
AdspManager
get
Get list of all Air Defense profiles
post
Create a new Air Defense profile
get
Get an Air Defense profile with default values
get
Get Air Defense profile name mapped to ID
get
Get an Air Defense Profile by ID
put
Update an Air Defense profile
del
Delete an Air Defense profile for a customer
get
Get list of all Air Defense profiles
post
Create a new Air Defense profile.
get
Get an Air Defense profile with default values
get
Get Air Defense profile name mapped to ID
get
Get an Air Defense profile by ID
put
Update an Air Defense profile
del
Delete an Air Defense profile
get
Get list of all Air Defense profiles
post
Create a new Air Defense profile
get
Get an Air Defense profile with default values
get
Get AirDefense profile name mapped to ID
get
Get an AirDefense Profile by ID
put
Update an AirDefense profile
del
Delete an AirDefense profile
AnalyticsProfileManager
get
Get list of all analytics profiles
post
Create a new Analytics Element
get
Get an Analytics profile with default values
get
Get an Analytics profile name to ID map
get
Get an Analytics profile by ID
put
Update an Analytics profile
del
Delete an Analytics profile for a customer
AuditlogManager
get
Get audit logs for a customer for a given time range
CoSManager
get
CoS Manager
post
Create a new policy Class of Service
get
Get the default Class of Service configuration
get
Get CoS name to ID map
get
Get a policy CoS by ID
put
Update a policy CoS
del
Delete a CoS for a customer
DeviceImageManager
get
Get list of device images for a hardware type
DpiSignatureManager
get
Get list of all Dpi signature profiles
put
Save list of Dpi Application elements
get
Get list of all custom Dpi signature profiles
EntityStateManager
get
Get the state of all access points
get
Get the state of all access points
get
Get the state of all sites
get
Get the state of all switches
get
Get the state of an access point based on serial number
get
Get the state of a site based on ID
get
Get the state of a switch based on serial number
get
Get the state of all access points for a site
IotProfileManager
get
Get list of all IoT profiles for a customer
post
Create a new IoT profile to the customer
get
Get an IoT profile with default values
get
Get IoT profile name mapped to ID
get
Get an IoT profile based on ID
put
Update an IoT profile based on ID
del
Delete an IoT profile
RtlsProfileManager
get
Get list of all RTLS profiles for a customer.
post
Create a new RTLS profile
get
Get RTLS profile with default values
get
Get RTLS profile name mapped to ID
get
Get RTLS profile by its ID
put
Update RTLS profile by ID
del
Delete RTLS profile by ID
NotificationManager
get
Get list of all notification
get
Get list of notifications for a region
PositioningManager
get
Get list of all Positioning profiles
post
Create a new Positioning profile
get
Get Positioning profile with default values
get
Get Positioning profile name mapped to ID
get
Get Positioning profile by ID
put
Update a Positioning profile
del
Delete a Positioning profile for a customer
ProfileManager
get
Get list of all profiles for a customer
post
Create a new profile
post
Create a new profile
post
Clone a profile
get
Get profile names mapped to IDs
get
Get a profile by its ID
put
Update a profile by its ID
del
Delete a profile by its ID
get
Get list of channels supported by profile radios
get
Get service IDs that are assigned to the primary BSSID. Removing these services may cause a radio reset.
RadioManager
get
Get channels for a radio mode and channel width
get
Get radio mode for a radio index
get
Get smartrfchannels for the given radio band type
RateLimiterManager
get
Get list of rate limiters for a customer
post
Create a new rate limiter for an access point
get
Get a rate limiter with default values
get
Get rate limiter names mapped to ID
get
Get a rate limiter by ID
put
Update a rate limiter by ID
del
Delete a rate limiter for a customer
ReportTemplateManager
get
Get a list of report templates.
post
Create a new report template
get
Get a report template by ID
put
Update a report template
del
Delete a template.
get
Get template with default values
get
Get template name mapped to ID
get
Get a list of scheduled reports
post
Create scheduled report
get
Get scheduled report setting
put
Update scheduled report setting
del
Delete a scheduled report
get
Get report with default values
get
Get report name mapped to ID
get
Get a list of generated user reports
get
Get a scheduled user report by filename
del
Delete a generated report.
put
Delete a list of generated report files
get
Get a list of available widget definitions
ReportsManager
get
Get Site report (replaced by /v3/sites/report)
get
Get AP report by AP serial (replaced by /v1/aps/{apSerialNumber}/report)
get
Get Smart RF reports for a given access point.
get
Get Site Flex report (replaced by /v3/sites/report/flex)
get
Get Port report by switch serial number (replaced by /v1/switches/{serialNumber}/ports/{portId}/report)
get
Get Role report by ID (replaced by /v1/roles/{roleId}/report)
get
Get Service report (replaced by /v1/services/{serviceId}/report)
get
Get Site report by ID (replaced by /v1/sites/{siteId}/report)
get
Get station by ID (replaced by /v1/stations/{stationId}/report)
get
Get Switch report by serial number (replaced by /v1/switches/{serialNumber}/report)
get
Get a list of all station locations for an AP by serial number (replaced by /v1/aps/{apSerialNumber}/location)
get
Get a list of all station locations on the given floor (replaced by /v3/sites/report/location/floor/{floorId})
get
Get a Location report for a station (replaced by /v1/stations/{stationId}/location)
get
Get Device Upgrade report
RfMgmtPolicyManager
get
Get list of all RF management policy profiles
post
Create a new RF management policy
get
Get RF management policy profile with default values
get
Get RF management policy profile name mapped to ID
get
Get RF management policy profile by ID
put
Update RF management policy profile
del
Delete RF management policy profile for a customer
RoleManager
get
Get list of all roles for a customer
post
Create a role
get
Get role with default values
get
Get roles names mapped to ID
get
Get role by its ID
put
Update a role
post
Create a role (given a service ID for creation of a special role)
del
Delete role for a customer
get
Get rule stats by role ID
get
Get current stations with role
get
Get available widgets for role report (/v1/roles/{roleId}/report PUT)
put
Get Role report by role ID. (Use /v1/roles/report/widgets to get all available widgets. Select one. Then, use /v1/roles/{roleId}/report/(PUT))
get
Get Role report by role ID
ServiceManager
get
Get list of all services.
post
Create a service
get
Get service with default values
get
Get service name mapped to ID
get
Get service by its ID
put
Update a service
del
Delete a service by its ID
get
Get list access point serial numbers for a service
get
Get list of site IDs at which the service is currently deployed
get
Get current stations of a service.
