Jump to Content
CentralGuidesAPI ReferenceGitHubAirheads Developer Community
HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog InCentral
Log In

SSO Configuration

  • SAML Metadata
    • SAML Metadata for the given domainget
  • IDP Authentication Source
    • List IDP Authentication Sourcesget
    • Add IDP Authentication Sourcepost
    • Update IDP Authentication Sourcepatch
    • Delete IDP Authentication Sourcedelete
    • Upload IDP Authentication Sourcepost
    • Upload IDP Authentication Source Certificatepost

AirGroup

  • Summary
    • Get AirGroup Traffic Summary in terms of Packetsget
    • Retrieves device summaryget
  • Trend
    • Get temporal data about AirGroup based on the parameter passedget
  • List
    • Retrieves list of labelsget
    • Get all the uncached services encountered by AirGroupget
    • Retrieves a list of all hostnamesget
  • Distribution
    • Retrieves a summary of all the services queried for.get
    • Retrieves a summary of the servers connected to AirGroupget
  • Stats
    • Retrieves the suppression factorget

AirMatch

  • reporting_radio
    • Get reporting_radio of a specific Radio MACget
    • Get All reporting_radio for a Customerget
  • ap_info
    • Get ap_info of a specific AP Ethernet MACget
    • Get ap_info for all APsget
    • Get feasibility ap_info of a specific AP Ethernet MACget
  • nbr_pathloss
    • Get nbr_pathloss of a Neighbor Mac heard by a specific Radio Macget
    • Get All nbr_pathloss for a Customer and Bandget
    • Get All nbr_pathloss for a Customer and Radio-Macget
  • rf_events
    • Get rf_events of a specific Radio MACget
    • Get all rf_events of a tenant-idget
  • priority_rf_events
    • Get radar and noise RF events of a specific Radio MACget
    • Get all radar and noise RF events of a tenantget
  • history
    • Get history of a specific Radio MACget
  • static_radios
    • Get All Static Radios for a Customerget
  • Advanced AP stats
    • Get Number of APs and AP Modelsget
  • Advanced Radio EIRP Stats
    • Get EIRP Distributionget
    • Get EIRP Reasonsget
    • Get EIRP Reasonsget
  • Advanced Radio Info
    • Get Information about Radioget
  • Advanced Radio NBR Stats
    • Get Neighbor stats informationget
  • bootstrap
    • Bootstrappost
  • purge
    • Purgepost
  • Solution
    • Get optimizations for tenantget
    • run the algorithm for the solutionpost
  • radio_plan
    • Get solution of a specific Radio MACget
    • Get All solutions for a Customerget
  • Solution per Partition
    • Get optimizations for tenant's requested partitionget
  • Advanced Deployment Stats
    • Gets Radios Deployment Statusget
  • Scheduler
    • RMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour detailspost
    • RMQ message triggers a runnow job for a certain tenantpost
    • get the schedule of all jobs computed by the schedulerget
    • get the jobs to be sent to deployer for airmatch solution deploymentget
    • Get the list of jobs generated by Schedulerget
    • Get the list of unique timezone and deploy hours per tenantget
    • Trigger - RMQ message with on-demand compute for a provided tenant-idpost
  • radio_feasibility
    • Trigger update of radio feasibilityput
    • Get radio_feasibility of a specific radio MACget
    • Get All radio_feasibility for a Customerget
    • Get radio_feasibility of a specific radio MACget
    • Get All radio_feasibility for a Customerget
  • device_config
    • Returns all Device (AP) Running Configuration for a Customerget
    • Returns Device (AP) Running Configurationget
    • Change a device Running Configput
    • Returns Device (AP) Running Configurationget
    • Change a device Running Configput
    • Returns all Device (AP) Running Configuration for a Customerget
  • service_config
    • Returns All Device (AP) Running Configuration for all customersget
    • Returns Device (AP) Running Configurationget
  • radio_info
    • Get Feasibility Radio info of a specific radio MACget
  • board_limit
    • Get board limits of a specific radio MACget
  • Deployer
    • get a list of pending deployments for a tenant-idget
    • Trigger Computation complete messagepost
    • RMQ message generates southbound test action-msgpost
    • Trigger test-config updatepost
  • AP
    • Get AP neighbor listget
    • Get AP neighbor listget
  • Radio
    • Get Radio neighbor listget
  • RF domain
    • Get partition informationget
    • Start partition processpost

AppRF

  • Overview
    • Gets Top N Apprf Statisticsget
    • Gets Top N Apprf Statistics (V2 Version)get
  • Applications
    • Gets Top N Applicationsget
  • Web Categories
    • Gets Top N Web categoriesget
  • App Categories
    • Gets Top N App categoriesget
  • Web Reputations
    • Gets Top Web Reputationsget
  • AppRF IAP Meta Info
    • Gets Web Reputation id to name mappingget
    • Gets Application id to name mappingget
    • Gets Application Category id to name mappingget
    • Gets Web Category id to name mappingget

Configuration Groups

  • Groups
    • Get all groups.get
    • Create new group.post
    • Create new group with specified properties.post
    • Clone and create new group.post
    • Get configuration mode set per device type for groups.get
    • Get properties set for groups.get
    • Update properties for the given group.patch
    • Update group name for the given group.patch
    • Get default group.get
    • Set default group.patch
    • Delete existing group.delete
    • (Deprecated) Get group.get
    • (Deprecated) Get all groups.get
    • (Deprecated) Create new group.post
  • Pre Provisioned Group
    • Pre Provision a group to the devicepost
    • (Deprecated: This API would be supported till November 2022) Assign Pre-Provisioned Grouppost
  • Templates
    • Get all templates in group.get
    • Create new template.post
    • Update existing template.patch
    • Get template text for a template in group.get
    • Delete existing template.delete
  • Configuration backup and restore
    • Create new configuration backup for group.post
    • Create new configuration backup for multiple groups.post
    • Get all configuration backups for the given group.get
    • Update do-not-delete flag for list of configuration backups for the given group.patch
    • Get last restore logs for the given group.get
    • Get backup-log for the given configuration backup for the given group.get
    • Get status of configuration backup for the given group.get
    • Get status of configuration restore for the given group.get
    • Restore configuration backup of a group.post
  • Devices
    • Move devices to a group.post
    • Get group for a device.get
    • Get last known running configuration for a device.get
    • Get configuration details for a device (only for template groups).get
    • Get templates for a list of devices.get
    • Get templates of devices present in the given list of groups.get
    • Get templates of devices for given template hash (Only allowed for user having all_groups access or admin).get
    • Get variablised template for an Aruba Switch.get
    • Set Username, password required for establishing SSH connection to switch.post
  • Variables
    • Get template variables for a device.get
    • Create template variables for a device.post
    • Update template variables for a device.patch
    • Replace all or delete some of the template variables for a device.put
    • Delete all of the template variables for a device.delete
    • Get template variables for all devices, Response is sorted by device serial.get
    • Create template variables for all devices.post
    • Replace all or delete some of the template variables for all devices.put
    • Update template variables for all devices (Only JSON Payload).patch
  • MM-MD
    • Trigger Mobility Device recovery by resetting (delete and add) Device configuration.post
  • Certificates
    • Get Certificates details uploaded.get
    • Upload a certificate.post
    • Delete existing certificate.delete
    • Update a certificate.put
  • Captive portal logo
    • Get Captive Portal Logos uploaded.get
    • Upload a captive portal logo.post
    • Delete existing captive portal logo.delete
  • MSP Templates
    • Get MSP customer level template details.get
    • Get MSP customer level template text.get
    • Delete MSP customer template.delete
    • Update MSP customer level template.put
    • Get end customer level template details.get
    • Get end customer level template text.get
    • Delete end customer template.delete
    • Update end customer level template.put
    • Get customers and groups where given MSP level template is not applied.get
    • Get groups for given end customer where MSP Level template is not applied.get
    • Apply MSP customer level template to end customers. This would not apply template to template groups at end customer.post
    • Apply end customer template to template groups at end customer.post
  • Configuration Mode
    • Get configuration mode as either Monitor or Managed mode at customer level.get
    • Set configuration mode as either Monitor or Manage at customer level.post
    • Get configuration mode for devices as either Monitor or Managed mode at group level.get
    • Set configuration mode as either Monitor or Manage at group level.post
    • Get configuration mode as either Monitor or Managed mode at device level.get
    • Set configuration mode as either Monitor or Manage for given devices.post
    • Get configuration mode as either Monitor or Managed mode for device serials.get
  • Variables firewall
    • Get whitelisted groups in Variables Firewall.get
    • Add groups to Variables Firewall whitelist.post
    • Delete group from Variables Firewall whitelist.delete
    • Get whitelisted variables in Variables Firewall.get
    • Add variables to Variables Firewall whitelist.post
    • Delete variable from Variables Firewall whitelist.delete
  • NB UI Group Configuration
    • Set country code at group level (For UI groups only, not supported for template groups). Note: IAP's need to be rebooted for changes to take effect.put
    • Get country code set for group (For UI groups only, not supported for template groups).get
  • Save Commit
    • Get auto commit state as either On or Off at group level.get
    • Set auto commit state as either On or Off at group level.post
    • Get auto commit state as either On or Off for device serials.get
    • Set auto commit state as either On or Off for given devices.post
    • Commit configurations for given groups.post
    • Commit configurations for given devices.post
  • denylist clients
    • Get all denylist client mac address in device.get
    • Add denylist clientspost
    • Delete denylist clientsdelete
  • WLAN Configuration
    • Get WLAN list of an UI group.get
    • Get WLAN default configuration.get
    • Get WLAN access rule protocol map.get
    • Get WLAN access rule services.get
    • (Deprecated) Get the information of an existing WLAN.get
    • (Deprecated) Create a new WLAN.post
    • (Deprecated) Update an existing WLAN and clean up unsupported fields.patch
    • (Deprecated) Update an existing WLAN.put
    • Delete an existing WLAN.delete
    • Get the information of an existing WLAN.get
    • Create a new WLAN.post
    • Update an existing WLAN and clean up unsupported fields.patch
    • Update an existing WLAN.put
    • Get WLAN list of an UI group.get
    • Get WLAN default configuration.get
    • Get WLAN access rule protocol map.get
    • Get WLAN access rule services.get
    • Get the information of an existing WLAN.get
    • Create a new WLAN.post
    • Update an existing WLAN.put
    • Delete an existing WLAN.delete
    • Get hotspot list of an UI group or swarm.get
    • Get hotspot list of an UI group or swarm with mode nameget
    • Get hotspot default configuration.get
    • Get the information of an existing hotspot.get
    • Create a new hotspot.post
    • Update an existing hotspot.put
    • Delete an existing hotspot.delete
  • AP Settings
    • (Deprecated) Get an existing ap settings.get
    • (Deprecated) Update an existing ap settings.post
    • Get an existing ap settings.get
    • Update an existing ap settings.post
  • AP Configuration
    • Get AP configuration.get
    • Replace AP configuration.post
    • Get per AP setting.get
    • Replace per AP setting.post
    • Get variables config.get
    • Replace AP variables.post
    • Get dirty diff.get
    • Get System Config.get
    • Update system config.post
    • Get ARM configuration.get
    • Update ARM configuration.post
    • Get all Dot11g Radio Profiles.get
    • Get Dot11g radio profile.get
    • Update/Create Dot11g radio profile.post
    • Delete Dot11g radio profile.delete
    • Get all Dot11a Radio Profiles.get
    • Get Dot11a radio profile.get
    • Update/Create Dot11a radio profile.post
    • Delete an existing Dot11a radio profile.delete
  • Swarm Config
    • (Deprecated) Get an existing swarm config.get
    • (Deprecated) Update an existing swarm config.post
    • Get an existing swarm config.get
    • Update an existing swarm config.post
  • CX Configuration
    • Get Interfacesget
    • Update Interfacespost
    • Get LAGsget
    • Create/Update/Delete LAGspost
    • Get Loop Preventionget
    • Update Loop Preventionpost
    • Get Propertiesget
    • Update Propertiespost
    • Get Syslogget
    • Create/Update/Delete Syslogpost
    • Get VLANsget
    • Create/Update/Delete VLANspost
  • AOS-S
    • Get ports name for a group.get
    • Update ports name for a group.put
    • Get ports name for a device.get
    • Update ports name for a device.put
    • Get vlans with tagged, untagged and isolated ports for a group.get
    • Update vlans with tagged, untagged and isolated ports for a group.put
    • Get vlans with tagged, untagged and isolated ports for a device.get
    • Update vlans with tagged, untagged and isolated ports for a device.put

Deprecated Device Inventory

  • Devices
    • Get devices from device inventoryget
    • Add device using Mac and Serial numberpost
    • Get devices statsget
    • Verify device additionpost
    • Get status of refresh jobget
    • Schedule a job to refresh the device inventorypost
    • (Deprecated) Get devices from device inventoryget
    • (Deprecated) Add device using Mac and Serial numberpost
    • (Deprecated) Get devices statsget
  • Private Cloud Devices
    • Get device from device inventoryget

Firmware

  • Firmware Management
    • List Firmware Details of Swarmsget
    • Firmware Details of Swarmget
    • List Firmware Details of Devicesget
    • Firmware Details of Deviceget
    • List Firmware Versionget
    • Firmware Versionget
    • Firmware Statusget
    • Firmware Upgradepost
    • Cancel Scheduled Upgradepost
    • Set Firmware Compliance Version Customerpost
    • Set Firmware Compliance Versionpost
    • Get Firmware Compliance Versionget
    • Clear Firmware Compliance Versiondelete
    • Firmware Upgrade at MSP Levelpost
    • Firmware Upgrade at Customer Levelpost
    • Cancel Scheduled Upgrade at MSP Levelpost
    • Cancel Scheduled Upgrade at Customer Levelpost
    • Cancel Scheduled Upgrade at MSP Levelpost
    • Cancel Scheduled Upgrade at Customer Levelpost
    • List Model Familyget
    • Set Firmware Compliance Version for MSP customerpost
    • Get Firmware Compliance Version for MSP Customerget
    • Clear Firmware Compliance Version for MSP Customerdelete
    • Set Firmware Compliance Version for Tenantpost
    • Get Firmware Compliance Version for Tenantget
    • Clear Firmware Compliance Version for Tenantdelete
    • List Tenants of an MSP customerget

GDPR

  • GDPR
    • List gdprs opt out MAC clients for this customerget
    • Add Gdpr opt out clientpost
    • GDPR Opt out MACget
    • Delete Opt out Macdelete

Guest

  • Portals
    • Get all portals with limited dataget
    • Create a new guest portal profilepost
    • Get preview url of guest portal profileget
    • Get guest portal profileget
    • Update guest portal profileput
    • Delete guest portal profiledelete
  • Visitors
    • Get all visitors created against a portalget
    • Create a new guest visitor of a portalpost
    • Get guest visitor accountget
    • Update guest visitor accountput
    • Delete guest visitor accountdelete
  • Sessions
    • Get all sessions of a ssidget
  • Wlans
    • Get all guest wlansget
  • Troubleshoot
    • Check if guest is enabled for current user.get
    • Provision cloud guest for current customerpost
  • WiFi4EU
    • WiFi4EU Statuspost
  • Summary
    • Get summary statisticsget

Deprecated Licensing

  • Subscriptions
    • (Deprecated) Get user subscription keysget
    • (Deprecated) Get subscription statsget
    • (Deprecated) Get enabled services for customerget
    • (Deprecated) Assign subscription to a devicepost
    • (Deprecated) Unassign subscription to a devicepost
    • (Deprecated) Get services licensing configget
    • Standalone customer API:- Assign licenses to all devices.post
    • Standalone customer API:- Un-assign licenses to all devices for given services.delete
    • MSP API:- Assign licenses to all the devices owned by tenant customers.post
    • MSP API:- Remove service licenses to all the devices owned by tenants and MSP.delete
  • Auto-License
    • (Deprecated) Get services and corresponding license token availability status.get
    • (Deprecated) Get the services which are auto enabled.get
    • (Deprecated) Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.post
    • (Deprecated) Standalone Customer API:- Disable auto licensing for given services.delete
    • (Deprecated) Get auto enabled services for msp or tenant customer.get
    • (Deprecated) MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.post
    • (Deprecated) MSP API:- Disable auto license settings at msp and its tenant level for given services.delete

Monitoring

  • Network
    • List all Networksget
    • List all Networksget
    • Get Network detailsget
    • Get Network detailsget
    • WLAN Network Bandwidth usageget
    • WLAN Network Bandwidth usageget
  • AP
    • List Access Pointsget
    • List Access Pointsget
    • List BSSIDsget
    • List BSSIDsget
    • AP Detailsget
    • Delete APdelete
    • AP Neighbouring Clientsget
    • AP RF Summaryget
    • AP RF Summaryget
    • AP RF Summaryget
    • AP uplink historyget
    • AP Bandwidth Usageget
    • AP Bandwidth Usageget
    • AP Bandwidth Usageget
    • Top N AP Detailsget
    • Top N AP Detailsget
  • Swarm
    • Top N Swarms By Bandwidth Usageget
    • Top N Swarms By Clients Countget
    • List Swarmsget
    • Swarm Detailsget
  • Client
    • List Wireless Clientsget
    • List Wired Clientsget
    • List Unified Clients (Wired/Wireless). Option to choose Connected/Failed Clientsget
    • Client Detailsget
    • Wireless Client Detailsget
    • Wireless Client Mobility Trailget
    • Wired Client Detailsget
    • Client Bandwidth Usageget
    • Top N Clientsget
    • Total Clients Countget
  • VPN
    • Vpn Detailsget
    • Swarm VPN statsget
    • Swarm VPN statsget
    • Swarm VPN statspost
  • MobilityController
    • List Mobility Controllersget
    • Mobility Controller Detailsget
    • Delete Mobility Controllerdelete
    • Mobility Controllers Ports Bandwidth Usageget
    • Mobility Controllers Ports Detailsget
    • Mobility Controllers VLAN detailsget
    • List Mobility Controllersget
    • Mobility Controller Detailsget
    • Delete Mobility Controllerdelete
  • Gateway
    • Gateway Listget
    • Gateway Detailsget
    • Delete Gatewaydelete
    • Gateway Uplink Detailsget
    • Gateway Uplink Bandwidth Usageget
    • Gateway Uplink tunnel statsget
    • Gateway Uplink WAN compression statsget
    • Gateway Uplink distributionget
    • Gateway Ports Bandwidth Usageget
    • Gateway Ports Detailsget
    • Gateway Port Errorsget
    • Gateway Tunnels Detailsget
    • Gateway DHCP Clients informationget
    • Gateway DHCP Pools detailsget
    • Gateway VLAN detailsget
  • Label
    • List Labelsget
    • Create Labelpost
    • List Default Labelsget
    • Label detailsget
    • Update Labelpatch
    • Delete Labeldelete
    • Associate Label to devicepost
    • Unassociate Label from devicedelete
    • Associate Label to a list of devicespost
    • Unassociate a label from a list of devicesdelete
    • List Label Categoriesget
  • Site
    • List Sitesget
    • Create Sitepost
    • Site detailsget
    • Update Sitepatch
    • Delete Sitedelete
    • Associate Site to devicepost
    • Unassociate Site from devicedelete
    • Associate Site to a list of devicespost
    • Unassociate a site from a list of devicesdelete
  • Switch
    • List Switchesget
    • Get vlan info of the switchget
    • Get vlan info for CX switchget
    • Get vlan info of the switch stackget
    • Get vlan info of the CX switch stackget
    • Get switch port poe infoget
    • Get switch port poe info for CX switchget
    • Get switch poe infoget
    • Get switch poe info for CX switchget
    • Get switch vsx info for CX switchget
    • Switch Bandwidth Usageget
    • Top N Switchesget
    • Switch Detailsget
    • Delete Switchdelete
    • Switch Ports Detailsget
    • Get ports details for CX switchget
    • Switch Chassis Detailsget
    • Switch Ports Bandwidth Usageget
    • Ports Bandwidth Usage for CX Switchget
    • Switch Ports Errorsget
    • CX Switch Ports Errorsget
    • Switch Stack Port Detailsget
    • CX Switch Stack Port Detailsget
    • List Switch Stacksget
    • Switch Stack Detailsget
    • Delete Switch Stackdelete
  • Events
    • (Deprecated) List Eventsget
    • List Eventsget

MSP

  • Customers
    • Get list of customers under the MSP account based on limit and offsetget
    • Create a new customerpost
    • Get details of customerget
    • Update a customerput
    • Delete a customerdelete
  • Users
    • Get list of users under the MSP account based on limit and offsetget
    • Get list of users under the Customer account based on limit and offsetget
  • Resources
    • Get the resource under the MSPget
    • Edit an existing resource for the MSPput
  • Devices
    • Get list of devices and licenses under the Customer account based on limit and offsetget
    • Move a device to an end-customerput
    • Get list of devices and licenses under the MSP account based on limit and offsetget
  • Groups
    • Get list of customers mapped to MSP group based on limit and offset.get

Network Health

  • Network Health
    • Get data for all labelsget
    • Get data for all sitesget

Notification

  • Types
    • List Typesget
  • Settings
    • List Settingsget
    • Add settingspost
    • Delete Settingsdelete
    • Update settings detailsput
    • Get Customer account level Settingsget
    • Update customer settingsput
  • Notification
    • Get notifications count by severityget
    • List Notificationsget
    • Acknowledge Notifications by ID List / Allpost
    • Acknowledge Notificationpatch

New Device Inventory

  • Devices
    • Get devices from device inventoryget
    • Add device using Mac and Serial numberpost
    • Delete devices using Serial numberdelete
    • Get devices statsget
    • Verify device additionpost
    • Get status of refresh jobget
    • Schedule a job to refresh the device inventorypost
    • Get Archived devices from device inventoryget
    • Archive devices using Serial listpost
    • Unarchive devices using Serial listpost
  • Private Cloud Devices
    • Get device from device inventoryget
  • MSP Devices
    • A filterable paginated response of a list of devices and licenses under the customer account based on the provided limit and offset parametersget
    • assign the device to the end-customerput
    • A filterable paginated response of a list of devices and licenses under the MSP account based on the provided limit and offset parameters.get

RAPIDS

  • Rogues
    • List Rogue APsget
    • List Interfering APsget
    • List suspect APsget
    • List neighbor APsget
    • Delete a roguedelete
  • SSIDs
    • List Allowed SSIDsget
    • Add Allowed SSIDspost
    • Delete Allowed SSIDsdelete
    • List Blocked SSIDsget
    • Add Blocked SSIDspost
    • Delete Blocked SSIDsdelete
  • WIDS
    • List Infrastructure Attacksget
    • List Client Attacksget
    • WIDS Eventsget

Reporting

  • Reports
    • Scheduled Reportsget
    • Generated Reportsget
    • Scheduled Reportsget
    • Generated Reportsget
  • SDWAN Reports
    • SDWAN DPS policy compliance reportget

Device Routing - BGP

  • Neighbor
    • List BGP neighbor Informationget
    • Get BGP neighbor detailed informationget
    • Reset/clear BGP neighbor sessionput
    • List of routes learned form a BGP neighborget
    • List of routes advertised to a BGP neighborget
  • Route
    • List BGP routesget

Device Routing - Overlay

  • Connection
    • Get information about overlay control connectionget
    • Reset overlay control connectionput
  • Interface
    • List of overlay interfaces (tunnels)get
  • RouteLearned
    • List of learned routes from overlayget
  • RouteLearnedBest
    • List of best learned routes from overlayget
  • RouteAdvertised
    • List of advertised routes to overlayget

Device Routing - OSPF

  • Area
    • List OSPF Area Informationget
  • Interface
    • List OSPF Interface Informationget
  • Neighbor
    • List OSPF neighbor Informationget
  • LinkStateDatabase
    • List OSPF Link State Database Informationget

Device Routing - RIP

  • Interface
    • List RIP interfacesget
  • Neighbor
    • List RIP neighborsget
    • List of routes learned from a RIP neighborget
  • Route
    • List RIP routesget

Device Routing - RoutingTable

  • Route
    • Get routesget
    • Get legacy routesget

Topology

  • Topology
    • Get topology details of a site.get
    • Get details of a device.get
    • Get details of an edge.get
    • Get details of an edge for the selected source and destination.get
    • Get details of an uplink.get
    • Get tunnel details.get
    • Get neighbor details reported by AP via LLDP.get
    • Get vlan list of a site.get
    • Get list of unreachable devices in a site.get

Troubleshooting

  • Troubleshooting
    • List Troubleshooting Commandsget
    • Start Troubleshooting Sessionpost
    • Get Troubleshooting Outputget
    • Clear Troubleshooting Sessiondelete
    • Get Troubleshooting Session IDget
    • Export Troubleshooting Outputget
    • Initiate Running Config Backup For A Single Devicepost
    • Get list of backups associated with the device serial with the given prefixget
    • Initiate Running Config Backup For All Devices In A Grouppost
    • Get list of backups associated with the device serialget
    • Fetch the backup stored against the given nameget
  • Action Command
    • Action command for enroll est certificatepost

User Management

  • Users
    • Create a user accountpost
    • (Deprecated) Create a user accountpost
    • Change user passwordpost
    • Reset user passwordpost
    • Get user account details specified by user idget
    • Get user account details specified by user idget
    • Update a user accountpatch
    • (Deprecated) Get User account details specified by user idget
    • Delete a user accountdelete
    • (Deprecated) Update a user account specified by user idpatch
    • List user accountsget
    • Create a user accountpost
    • update user account details specified by user id.Providing info on account setting app is mandatory in this API along with other subscribed apps.Scope must be given only for NMS app. For non-nms apps such as account setting refer the parameters in the example json payload.patch
    • Get user account details specified by user idget
    • delete user account details specified by user iddelete
    • Change user passwordpost
    • Reset user passwordpost
  • Users_bulk_support
    • Create multiple users accountpost
    • Update multiple users accountpatch
    • Delete multiple users accountdelete
    • Get task statusget
  • Roles
    • Get all user rolesget
    • Create a user rolepost
    • Get User role detailsget
    • Delete a user roledelete
    • Update a user rolepatch
    • Get list of all rolesget
    • Get Role detailsget
    • Delete a roledelete
    • Update a rolepatch
    • Create a role in an apppost
  • Bulk Users
    • Create multiple users account. The max no of accounts that can be created at once is 10.post
    • Update multiple users account. The max no of accounts that can be updated at once is 10.Providing role on account setting app is mandatory in this API along with other subscribed apps. Scope must be given only for NMS app. For non-nms apps such as account setting refer the parameters in the example json payload.patch
    • Delete multiple users account. The max no of accounts that can be deleted at once is 10.delete
    • Get task statusget

VisualRF

  • Client Location
    • Get location of a specific clientget
    • Get a specific floor and location of all its clientsget
  • Rogue Location
    • Get location of a specific rogue access pointget
    • Get a specific floor and location of all its rogue access pointsget
  • Floorplan
    • (Deprecated) Get list of all campusesget
    • (Deprecated) Get a specific campus and its buildingsget
    • Get a specific building and its floorsget
    • Get details of a specific floorget
    • Get background image of a specific floorget
    • Get a specific floor and location of all its access pointsget
    • Get location of a specific access pointget

New Licensing

  • Subscriptions
    • Get user subscription keysget
    • Get subscription statsget
    • Assign subscription to a devicepost
    • Unassign subscription to a devicepost
    • Get enabled services for customerget
    • Get services licensing configget
    • Standalone customer API:- Assign licenses to all devices.post
    • Standalone customer API:- Un-assign licenses to all devices for given services.delete
    • MSP API:- Assign licenses to all the devices owned by tenant customers.post
    • MSP API:- Remove service licenses to all the devices owned by tenants and MSP.delete
  • Auto-License
    • Get services and corresponding license token availability status.get
    • Get the services which are auto enabled.get
    • Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.post
    • Standalone Customer API:- Disable auto licensing for given services.delete
    • Get auto enabled services for msp or tenant customer.get
    • MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.post
    • MSP API:- Disable auto license settings at msp and its tenant level for given services.delete

Webhook

  • Webhooks
    • List webhooksget
    • Add Webhookpost
    • Webhook setting for a specific itemget
    • Delete Webhooksdelete
    • Update webhook settingsput
    • Get Webhook Tokenget
    • Refresh the webhook tokenput
    • Test for webhook notificationget

AIOps

  • Wi-Fi Connectivity Dashboard
    • Wi-Fi Connectivity at Globalget
    • Wi-Fi Connectivity at Siteget
    • Wi-Fi Connectivity at Groupget
  • AI Insights List
    • List AI Insights for a Networkget
    • List AI Insights for a Siteget
    • List AI Insights for an APget
    • List AI Insights for a Clientget
    • List AI Insights for a Gatewayget
    • List AI Insights for a Switchget
  • AI Insight Details
    • AI Insight Details for a Networkget
    • AI Insight Details for a Siteget
    • AI Insight Details for an APget
    • AI Insight Details for a Clientget
    • AI Insight Details for a Gatewayget
    • AI Insight Details for a Switchget

ACP Audit Trail

  • audit
    • Get all audit logsget
    • Get details of an audit logget

Audit Event Logs

  • audit
    • Get all audit events for all groupsget
    • Get details of an audit event/logget

Authentication & Policy

  • Client Policy
    • Fetch network access policy for registered clients.get
    • Configure or update network access policy for registered clients.put
    • Delete existing Client Policy.delete
  • Client Registration
    • Fetch list of registered clients.get
    • Add registered client.post
    • Delete registered client.delete
    • Update registered client name.patch
  • User Policy
    • Fetch policy that allows wireless network access for users.get
    • Configure policy to allow wireless network access for users.put
    • Delete existing User Policy.delete

Client Match

  • Status
    • Get the status of Client Match for a tenantget
    • Enable or disable Client Match for a particular tenant.post
    • Get the status of Client Match Load Balancer for a tenantget
    • Enable or disable Client Match Load Balancer for a particular tenant.post
  • Unsteerable
    • Get all unsteerable entries for a tenantget
    • Get the unsteerable state of a clientget
    • Set the unsteerable state of a clientpost
    • Delete the unsteerable state of a clientdelete

Device Management

  • ActionCommand
    • Generic commands for devicepost
    • Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
    • Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
    • Generic commands for swarmpost
    • Disconnect Userpost
    • Speed Testpost
    • Statusget
    • Move the devices across customerspost
  • Pre Provisioned Group
    • Assign Pre-Provisioned Grouppost
  • DMS
    • Trigger activate sync for given MobilityMasterpost
    • Statically assign Mobility Master to Mobility Device.post
    • Get assigned Mobility Master to Mobility Device.get
    • Delete Mobility Master to Mobility Device mappingdelete
  • PSKeys
    • (Deprecated) Get ps keys from device inventoryget
    • (Deprecated) Add PS Keyspost
    • (Deprecated) Delete PS Keys using namedelete
  • Controller Management
    • (Deprecated) Get list of controller discovery details from device inventoryget
    • (Deprecated) Add Controller Profile to Device Inventorypost
    • (Deprecated) Update Controller Profile from Device Inventoryput
    • (Deprecated) Delete controller profile using Serial numberdelete
    • (Deprecated) Get controller settings using Serialget
    • (Deprecated) Add HTTPS Connection profile detailspost
    • (Deprecated) Update HTTPS Connection profile detailsput
    • (Deprecated) Get list of HTTPS Connection profile detailsget
    • (Deprecated) Get https connection profile details using nameget
    • (Deprecated) Add SNMP Connection profile detailspost
    • (Deprecated) Update SNMP Connection profile detailsput
    • (Deprecated) Get list of SNMP Connection profile detailsget
    • (Deprecated) Get SNMP connection profile details using nameget

DPS Monitoring

  • DPS
    • Gets DPS Policy stats for a given BOC.get
    • Gets DPS Policy stats for a given BOC.get
    • DPS Key Performance Indicator for a given BOC.get
    • DPS Compliance percentage of all DPS Policies for a given BOC.get
    • DPS Compliance Status of all DPS Policies for a given BOC.get
    • Gets DPS Policy Event Logs for a given BOC.get
    • Gets DPS Compliance stats for a given Site.get

Install Manager

  • Installers
    • Invite a new installerpost
  • Sites
    • For a given set of site names, assign Group Names for each device typepost

IOT Operations - Appstore

  • App Store
    • Search appsget
    • Find all installed appsget
    • Count all installed appsget
    • Get Appget
    • Get App Iconget
    • Install apppost
    • Edit Installed app configurationpost
    • Delete appdelete
    • Upgrade apppost
    • Developer appsget
    • Edit Developer installed app configurationpost
    • Get Developer Appget
    • Get Developer App Iconget
    • Install Developer apppost
    • Delete Developer appdelete
    • Upgrade developer apppost
    • Developer infoget
    • Find Recommended Appsget

IOT Operations - Device

  • Devices
    • Return Pageable List of all devicesget
    • Return Pageable List of all devicesget
    • Return the count of devices with one or more device classesget
    • Return the count of devicesget
    • Return the count of devices by Device Classget
    • Return the count of devices reporters by Collectorget
    • Return the count of devices by typeget
    • Return a time-series device count by collectorIdget
    • Return a device by Idget
    • Return Pageable List of Attributesget
    • Return the time-series from deviceget

IOT Operations - Iotgateway

  • iot_gateways
    • Return Pageable List of Gatewaysget
    • Return Pageable List of Gatewaysget
    • Return a Gateway by cluster Idget
  • association
    • Return Pageable List of Gatewaysget
    • Add Associationpost
    • Delete Associationdelete
    • Return Pageable List of Gatewaysget
    • Returns security token associated with a collectorget
  • groups
    • Returns connector to group mappingget
    • Group movepost
    • Group movedelete

IOT Operations - Transport Profile

  • Transport Profile
    • Find transport profilesget
    • Create a transport profilepost
    • Count transport profilesget
    • Get a list of all device classesget
    • Get a transport profile by idget
    • Update a transport profile by idput
    • Delete a transport profile by iddelete

ACP OFC Api Handler

  • Flowhandler
    • Enable/Disable the Syslog App.post
    • Enable Syslog App on a list of given device SerialIDs.post
    • Check Status of Syslog App for given SerialIDs.post
    • Check Status of Enabled Flow SerialIDget

Presence Analytics

  • Config
    • It configures RSSI threshold, dwelltime threshold for visitor & RSSI threshold for passerby.post
    • It retrieves RSSI threshold for passerby conversion, RSSI threshold for visitor conversion & dwelltime threshold for passerby to visitor conversion.get
    • It retrieves visitor RSSI threshold, passerby RSSI threshold, dwell time threshold, access points and site name for site level configuration.get
    • it configure RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.post
    • it retrieves RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.get
  • Associated
    • Get details of connected and non connected visitors.get
  • Loyalty
    • Get loyalty visitors frequency.get
    • Get presence analytics trends.get
    • Get loyalty indicator aggregate valuesget
    • Get loyalty indicator trendsget
    • Get loyalty visits of visitors in histogramget
    • Get Top 5 sites Loyalty indicator aggregate values.get
    • Get Bottom 5 sites Loyalty indicator aggregate values.get
    • Get Top 5 sites Loyalty trends.get
    • Get Bottom 5 sites Loyalty trends.get
    • Get loyalty aggregate values for list of sitesget
  • PresenceStats
    • Get presence analytics trends.get
    • Get presence analytics metrics aggregate valuesget
    • Get presence analytics trendsget
  • License
    • Enable or disable PA license.post
    • Customer level device license status.get
    • List of devices per site with their pa license status.get
  • Insights
    • Get presence aggregate values for list of sites.get
    • Get Top 5 sites aggregate values.get
    • Get Bottom 5 sites aggregate values.get
    • Get presence aggregate values for list of sitesget

Refresh API Token

  • refresh_api_token
    • Refresh API tokenpost

Service AirGroup

  • Aruba airgroup
    • Retrieve dialget
    • Create dialpost
    • Create/Update dialput
    • Delete dialdelete
    • Retrieve standard_servicesget
    • Create standard_servicespost
    • Create/Update standard_servicesput
    • Delete standard_servicesdelete
    • Retrieve disallowed for airplayget
    • Create disallowed for airplaypost
    • Create/Update disallowed for airplayput
    • Delete disallowed for airplaydelete
    • Retrieve disallowed for dialget
    • Create disallowed for dialpost
    • Create/Update disallowed for dialput
    • Delete disallowed for dialdelete
    • Retrieve airplayget
    • Create airplaypost
    • Create/Update airplayput
    • Delete airplaydelete
    • Retrieve amazon_tvget
    • Create amazon_tvpost
    • Create/Update amazon_tvput
    • Delete amazon_tvdelete
    • Retrieve general_settingsget
    • Create general_settingspost
    • Create/Update general_settingsput
    • Delete general_settingsdelete
    • Retrieve airprintget
    • Create airprintpost
    • Create/Update airprintput
    • Delete airprintdelete
    • Retrieve configget
    • Create configpost
    • Create/Update configput
    • Delete configdelete
    • Retrieve googlecastget
    • Create googlecastpost
    • Create/Update googlecastput
    • Delete googlecastdelete
    • Retrieve disallowed for amazon tvget
    • Create disallowed for amazon tvpost
    • Create/Update disallowed for amazon tvput
    • Delete disallowed for amazon tvdelete
    • Retrieve node_list by identifier node-type node-idget
    • Retrieve airgroup_statusget
    • Create airgroup_statuspost
    • Create/Update airgroup_statusput
    • Delete airgroup_statusdelete
    • Retrieve disallowed for googlecastget
    • Create disallowed for googlecastpost
    • Create/Update disallowed for googlecastput
    • Delete disallowed for googlecastdelete
    • Retrieve dlnaprintget
    • Create dlnaprintpost
    • Create/Update dlnaprintput
    • Delete dlnaprintdelete
    • Retrieve disallowed for dlnamediaget
    • Create disallowed for dlnamediapost
    • Create/Update disallowed for dlnamediaput
    • Delete disallowed for dlnamediadelete
    • Retrieve disallowed for airprintget
    • Create disallowed for airprintpost
    • Create/Update disallowed for airprintput
    • Delete disallowed for airprintdelete
    • Retrieve dlnamediaget
    • Create dlnamediapost
    • Create/Update dlnamediaput
    • Delete dlnamediadelete
    • Retrieve disallowed for dlnaprintget
    • Create disallowed for dlnaprintpost
    • Create/Update disallowed for dlnaprintput
    • Delete disallowed for dlnaprintdelete

Service Airmatch

  • Aruba airmatch
    • Retrieve configget
    • Create configpost
    • Create/Update configput
    • Delete configdelete
    • Retrieve systemget
    • Create systempost
    • Create/Update systemput
    • Delete systemdelete
    • Retrieve node_list by identifier node-type node-idget

Service Cloud Security

  • Aruba cloud security
    • Retrieve configget
    • Create configpost
    • Create/Update configput
    • Delete configdelete
    • Retrieve zscalerget
    • Create zscalerpost
    • Create/Update zscalerput
    • Delete zscalerdelete
    • Retrieve node_list by identifier node-type node-idget

Service IDS IPS

  • Aruba ids ips
    • Retrieve node_list by identifier node-type node-idget
    • Retrieve siem_servers_listget
    • Retrieve siem_servers_list by identifier siem_server_nameget
    • Create siem_servers_list by identifier siem_server_namepost
    • Create/Update siem_servers_list by identifier siem_server_nameput
    • Delete siem_servers_list by identifier siem_server_namedelete
    • Retrieve siem_notificationget
    • Create siem_notificationpost
    • Create/Update siem_notificationput
    • Delete siem_notificationdelete
    • Retrieve configget
    • Create configpost
    • Create/Update configput
    • Delete configdelete

Service IPMS

  • Aruba ipms
    • Retrieve ip_rangeget
    • Retrieve configget
    • Delete configdelete
    • Retrieve address_poolget
    • Retrieve address_pool by identifier pool_nameget
    • Create address_pool by identifier pool_namepost
    • Create/Update address_pool by identifier pool_nameput
    • Delete address_pool by identifier pool_namedelete
    • Retrieve ip_range by identifier range_idget
    • Create ip_range by identifier range_idpost
    • Create/Update ip_range by identifier range_idput
    • Delete ip_range by identifier range_iddelete
    • Retrieve node_list by identifier node-type node-idget

Service Overlay Wlan

  • Aruba overlay wlan
    • Retrieve gw_cluster_list by identifier cluster_redundancy_type cluster_group_nameget
    • Create gw_cluster_list by identifier cluster_redundancy_type cluster_group_namepost
    • Create/Update gw_cluster_list by identifier cluster_redundancy_type cluster_group_nameput
    • Delete gw_cluster_list by identifier cluster_redundancy_type cluster_group_namedelete
    • Retrieve gw_cluster_listget
    • Retrieve configget
    • Create configpost
    • Create/Update configput
    • Delete configdelete
    • Retrieve ssid_cluster by identifier profile profile_typeget
    • Create ssid_cluster by identifier profile profile_typepost
    • Create/Update ssid_cluster by identifier profile profile_typeput
    • Delete ssid_cluster by identifier profile profile_typedelete
    • Retrieve ssid_clusterget
    • Retrieve node_list by identifier node-type node-idget

Service SDWAN

  • Global Settings
    • Retrieve admin-statusget
    • Create/Update topologyput
    • Create topologypost
    • Delete topologydelete
    • Retrieve topologyget
    • Retrieve sdwan-globalget
  • DC Preference
    • Create/Update hub-clusters by cluster name and cluster groupput
    • Create by hub-clusters cluster name and cluster grouppost
    • Delete by hub-clusters cluster name and cluster groupdelete
    • Retrieve by hub-clusters cluster name and cluster groupget
    • Retrieve hub-clustersget
    • Retrieve hubsget
    • Create/Update hubs by device serial numberput
    • Create hubs by device serial numberpost
    • Delete hubs by device serial numberdelete
    • Retrieve hubs by device serial numberget
    • Create/Update branch-configput
    • Create branch-configpost
    • Delete branch-configdelete
    • Retrieve branch-configget
  • Route Policy
    • Create/Update load-balance-orchestrationput
    • Create load-balance-orchestrationpost
    • Delete load-balance-orchestrationdelete
    • Retrieve load-balance-orchestrationget
    • Retrieve route-policyget
    • Create/Update as-numberput
    • Create as-numberpost
    • Delete as-numberdelete
    • Retrieve as-numberget
    • Create/Update hubput
    • Create hubpost
    • Delete hubdelete
    • Retrieve hubget
    • Create/Update best-path-computationput
    • Create best-path-computationpost
    • Delete best-path-computationdelete
    • Retrieve best-path-computationget
    • Create/Update Global graceful restart timerput
    • Create Global graceful restart timerpost
    • Delete Global graceful restart timerdelete
    • Retrieve Global graceful restart timerget
    • Create/Update timerput
    • Create timerpost
    • Delete timerdelete
    • Retrieve timerget
  • Network Segments
    • Retrieve network-segment-policyget
    • Create/Update network-segment-policy by segment nameput
    • Create network-segment-policy by segment namepost
    • Delete network-segment-policy by segment namedelete
    • Retrieve network-segment-policy by segment nameget
  • Tunnel Policy
    • Create/Update tunnel-policyput
    • Create tunnel-policypost
    • Delete tunnel-policydelete
    • Retrieve tunnel-policyget
    • Create/Update rekey-intervalput
    • Create rekey-intervalpost
    • Delete rekey-intervaldelete
    • Retrieve rekey-intervalget
  • Branch Mesh
    • Retrieve branch-mesh by labelget
    • Retrieve branch-meshget
    • Create/Update branch-devices by device serial numberput
    • Create branch-devices by device serial numberpost
    • Delete branch-devices by device serial numberdelete
    • Retrieve branch-devices by device serial numberget
    • Create/Update branch-mesh configput
    • Create branch-mesh configpost
    • Delete branch-mesh configdelete
    • Retrieve branch-mesh configget
    • Retrieve branch-mesh-uiget
    • Retrieve branch-devicesget
  • Hub Configuration
    • Create/Update transitput
    • Create transitpost
    • Delete transitdelete
    • Retrieve transitget
    • Retrieve hub-configget
  • Hub Mesh
    • Create/Update hub-mesh by labelput
    • Create hub-mesh by labelpost
    • Delete hub-mesh by labeldelete
    • Retrieve hub-mesh by labelget
    • Retrieve hub-meshget
    • Create/Update hub-groups by nameput
    • Create hub-groups by namepost
    • Delete hub-groups by namedelete
    • Retrieve hub-groups by nameget
    • Retrieve hub-groupsget
  • Group Configuration
    • Delete configdelete
    • Retrieve configget
    • Retrieve node_list by identifier node-type node-idget
  • DC Aggregates
    • Retrieve hub-aggregatesget
    • Retrieve aggregates for hub-aggregatesget
    • Create/Update DC aggregate routes by prefix for given network segmentput
    • Create DC aggregate routes by prefix for given network segmentpost
    • Delete DC aggregate routes by prefix for given network segmentdelete
    • Retrieve DC aggregate routes by prefix for given network segmentget
    • Create/Update DC aggregate routes for given network segmentput
    • Create DC aggregate routes for given network segmentpost
    • Delete DC aggregate routes for given network segmentdelete
    • Retrieve DC aggregate routes for given network segmentget
  • Mesh Policy
    • Delete mesh-policydelete
    • Retrieve mesh-policyget
  • Branch Aggregates
    • Retrieve aggregates for branch-aggregatesget
    • Retrieve branch-aggregatesget
    • Create/Update global branch aggregate routes by prefix for given network segmentput
    • Create global branch aggregate routes by prefix for given network segmentpost
    • Delete global branch aggregate routes by prefix for given network segmentdelete
    • Retrieve global branch aggregate routes by prefix for given network segmentget
    • Create/Update global branch aggregate routes for given network segmentput
    • Create global branch aggregate routes for given network segmentpost
    • Delete global branch aggregate routes for given network segmentdelete
    • Retrieve global branch aggregate routes for given network segmentget

Service UCC

  • Aruba ucc
    • Retrieve dns_patternsget
    • Retrieve sipget
    • Create sippost
    • Create/Update sipput
    • Delete sipdelete
    • Retrieve skype4bget
    • Create skype4bpost
    • Create/Update skype4bput
    • Delete skype4bdelete
    • Retrieve ucc_settingsget
    • Create ucc_settingspost
    • Create/Update ucc_settingsput
    • Delete ucc_settingsdelete
    • Retrieve node_list by identifier node-type node-idget
    • Retrieve dns_patterns by identifier dns_patternget
    • Create dns_patterns by identifier dns_patternpost
    • Create/Update dns_patterns by identifier dns_patternput
    • Delete dns_patterns by identifier dns_patterndelete
    • Retrieve configget
    • Create configpost
    • Create/Update configput
    • Delete configdelete
    • Retrieve wifi_callingget
    • Create wifi_callingpost
    • Create/Update wifi_callingput
    • Delete wifi_callingdelete
    • Retrieve ucc_algget
    • Create ucc_algpost
    • Create/Update ucc_algput
    • Delete ucc_algdelete
    • Retrieve activateget
    • Create activatepost
    • Create/Update activateput
    • Delete activatedelete

Unified Communications

  • Summary
    • Fetch Summaryget
  • UC Clients
    • Fetch number of Clientsget
  • Session counts by session type
    • Fetch session counts based on session typeget
  • Session counts by alg
    • Fetch session counts based on alg nameget
  • Session quality by Session type
    • Fetch session quality based on session typeget
  • Session quality by SSID
    • Fetch session quality based on ssidget
  • Insights count
    • Fetch number of insights for a dayget
  • Insights
    • Fetch insights for a day. start time 00:00:00 and end time 23:59:59get
  • CDR
    • Fetch list of CDRsget
    • Export list of CDRsget
  • SkypeCentralURL
    • Fetch skype server central termination URLget

SSO Configuration

  • SAML Metadata
    • SAML Metadata for the given domainget
  • IDP Authentication Source
    • List IDP Authentication Sourcesget
    • Add IDP Authentication Sourcepost
    • Update IDP Authentication Sourcepatch
    • Delete IDP Authentication Sourcedelete
    • Upload IDP Authentication Sourcepost
    • Upload IDP Authentication Source Certificatepost

AirGroup

  • Summary
    • Get AirGroup Traffic Summary in terms of Packetsget
    • Retrieves device summaryget
  • Trend
    • Get temporal data about AirGroup based on the parameter passedget
  • List
    • Retrieves list of labelsget
    • Get all the uncached services encountered by AirGroupget
    • Retrieves a list of all hostnamesget
  • Distribution
    • Retrieves a summary of all the services queried for.get
    • Retrieves a summary of the servers connected to AirGroupget
  • Stats
    • Retrieves the suppression factorget

AirMatch

  • reporting_radio
    • Get reporting_radio of a specific Radio MACget
    • Get All reporting_radio for a Customerget
  • ap_info
    • Get ap_info of a specific AP Ethernet MACget
    • Get ap_info for all APsget
    • Get feasibility ap_info of a specific AP Ethernet MACget
  • nbr_pathloss
    • Get nbr_pathloss of a Neighbor Mac heard by a specific Radio Macget
    • Get All nbr_pathloss for a Customer and Bandget
    • Get All nbr_pathloss for a Customer and Radio-Macget
  • rf_events
    • Get rf_events of a specific Radio MACget
    • Get all rf_events of a tenant-idget
  • priority_rf_events
    • Get radar and noise RF events of a specific Radio MACget
    • Get all radar and noise RF events of a tenantget
  • history
    • Get history of a specific Radio MACget
  • static_radios
    • Get All Static Radios for a Customerget
  • Advanced AP stats
    • Get Number of APs and AP Modelsget
  • Advanced Radio EIRP Stats
    • Get EIRP Distributionget
    • Get EIRP Reasonsget
    • Get EIRP Reasonsget
  • Advanced Radio Info
    • Get Information about Radioget
  • Advanced Radio NBR Stats
    • Get Neighbor stats informationget
  • bootstrap
    • Bootstrappost
  • purge
    • Purgepost
  • Solution
    • Get optimizations for tenantget
    • run the algorithm for the solutionpost
  • radio_plan
    • Get solution of a specific Radio MACget
    • Get All solutions for a Customerget
  • Solution per Partition
    • Get optimizations for tenant's requested partitionget
  • Advanced Deployment Stats
    • Gets Radios Deployment Statusget
  • Scheduler
    • RMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour detailspost
    • RMQ message triggers a runnow job for a certain tenantpost
    • get the schedule of all jobs computed by the schedulerget
    • get the jobs to be sent to deployer for airmatch solution deploymentget
    • Get the list of jobs generated by Schedulerget
    • Get the list of unique timezone and deploy hours per tenantget
    • Trigger - RMQ message with on-demand compute for a provided tenant-idpost
  • radio_feasibility
    • Trigger update of radio feasibilityput
    • Get radio_feasibility of a specific radio MACget
    • Get All radio_feasibility for a Customerget
    • Get radio_feasibility of a specific radio MACget
    • Get All radio_feasibility for a Customerget
  • device_config
    • Returns all Device (AP) Running Configuration for a Customerget
    • Returns Device (AP) Running Configurationget
    • Change a device Running Configput
    • Returns Device (AP) Running Configurationget
    • Change a device Running Configput
    • Returns all Device (AP) Running Configuration for a Customerget
  • service_config
    • Returns All Device (AP) Running Configuration for all customersget
    • Returns Device (AP) Running Configurationget
  • radio_info
    • Get Feasibility Radio info of a specific radio MACget
  • board_limit
    • Get board limits of a specific radio MACget
  • Deployer
    • get a list of pending deployments for a tenant-idget
    • Trigger Computation complete messagepost
    • RMQ message generates southbound test action-msgpost
    • Trigger test-config updatepost
  • AP
    • Get AP neighbor listget
    • Get AP neighbor listget
  • Radio
    • Get Radio neighbor listget
  • RF domain
    • Get partition informationget
    • Start partition processpost

AppRF

  • Overview
    • Gets Top N Apprf Statisticsget
    • Gets Top N Apprf Statistics (V2 Version)get
  • Applications
    • Gets Top N Applicationsget
  • Web Categories
    • Gets Top N Web categoriesget
  • App Categories
    • Gets Top N App categoriesget
  • Web Reputations
    • Gets Top Web Reputationsget
  • AppRF IAP Meta Info
    • Gets Web Reputation id to name mappingget
    • Gets Application id to name mappingget
    • Gets Application Category id to name mappingget
    • Gets Web Category id to name mappingget

Configuration Groups

  • Groups
    • Get all groups.get
    • Create new group.post
    • Create new group with specified properties.post
    • Clone and create new group.post
    • Get configuration mode set per device type for groups.get
    • Get properties set for groups.get
    • Update properties for the given group.patch
    • Update group name for the given group.patch
    • Get default group.get
    • Set default group.patch
    • Delete existing group.delete
    • (Deprecated) Get group.get
    • (Deprecated) Get all groups.get
    • (Deprecated) Create new group.post
  • Pre Provisioned Group
    • Pre Provision a group to the devicepost
    • (Deprecated: This API would be supported till November 2022) Assign Pre-Provisioned Grouppost
  • Templates
    • Get all templates in group.get
    • Create new template.post
    • Update existing template.patch
    • Get template text for a template in group.get
    • Delete existing template.delete
  • Configuration backup and restore
    • Create new configuration backup for group.post
    • Create new configuration backup for multiple groups.post
    • Get all configuration backups for the given group.get
    • Update do-not-delete flag for list of configuration backups for the given group.patch
    • Get last restore logs for the given group.get
    • Get backup-log for the given configuration backup for the given group.get
    • Get status of configuration backup for the given group.get
    • Get status of configuration restore for the given group.get
    • Restore configuration backup of a group.post
  • Devices
    • Move devices to a group.post
    • Get group for a device.get
    • Get last known running configuration for a device.get
    • Get configuration details for a device (only for template groups).get
    • Get templates for a list of devices.get
    • Get templates of devices present in the given list of groups.get
    • Get templates of devices for given template hash (Only allowed for user having all_groups access or admin).get
    • Get variablised template for an Aruba Switch.get
    • Set Username, password required for establishing SSH connection to switch.post
  • Variables
    • Get template variables for a device.get
    • Create template variables for a device.post
    • Update template variables for a device.patch
    • Replace all or delete some of the template variables for a device.put
    • Delete all of the template variables for a device.delete
    • Get template variables for all devices, Response is sorted by device serial.get
    • Create template variables for all devices.post
    • Replace all or delete some of the template variables for all devices.put
    • Update template variables for all devices (Only JSON Payload).patch
  • MM-MD
    • Trigger Mobility Device recovery by resetting (delete and add) Device configuration.post
  • Certificates
    • Get Certificates details uploaded.get
    • Upload a certificate.post
    • Delete existing certificate.delete
    • Update a certificate.put
  • Captive portal logo
    • Get Captive Portal Logos uploaded.get
    • Upload a captive portal logo.post
    • Delete existing captive portal logo.delete
  • MSP Templates
    • Get MSP customer level template details.get
    • Get MSP customer level template text.get
    • Delete MSP customer template.delete
    • Update MSP customer level template.put
    • Get end customer level template details.get
    • Get end customer level template text.get
    • Delete end customer template.delete
    • Update end customer level template.put
    • Get customers and groups where given MSP level template is not applied.get
    • Get groups for given end customer where MSP Level template is not applied.get
    • Apply MSP customer level template to end customers. This would not apply template to template groups at end customer.post
    • Apply end customer template to template groups at end customer.post
  • Configuration Mode
    • Get configuration mode as either Monitor or Managed mode at customer level.get
    • Set configuration mode as either Monitor or Manage at customer level.post
    • Get configuration mode for devices as either Monitor or Managed mode at group level.get
    • Set configuration mode as either Monitor or Manage at group level.post
    • Get configuration mode as either Monitor or Managed mode at device level.get
    • Set configuration mode as either Monitor or Manage for given devices.post
    • Get configuration mode as either Monitor or Managed mode for device serials.get
  • Variables firewall
    • Get whitelisted groups in Variables Firewall.get
    • Add groups to Variables Firewall whitelist.post
    • Delete group from Variables Firewall whitelist.delete
    • Get whitelisted variables in Variables Firewall.get
    • Add variables to Variables Firewall whitelist.post
    • Delete variable from Variables Firewall whitelist.delete
  • NB UI Group Configuration
    • Set country code at group level (For UI groups only, not supported for template groups). Note: IAP's need to be rebooted for changes to take effect.put
    • Get country code set for group (For UI groups only, not supported for template groups).get
  • Save Commit
    • Get auto commit state as either On or Off at group level.get
    • Set auto commit state as either On or Off at group level.post
    • Get auto commit state as either On or Off for device serials.get
    • Set auto commit state as either On or Off for given devices.post
    • Commit configurations for given groups.post
    • Commit configurations for given devices.post
  • denylist clients
    • Get all denylist client mac address in device.get
    • Add denylist clientspost
    • Delete denylist clientsdelete
  • WLAN Configuration
    • Get WLAN list of an UI group.get
    • Get WLAN default configuration.get
    • Get WLAN access rule protocol map.get
    • Get WLAN access rule services.get
    • (Deprecated) Get the information of an existing WLAN.get
    • (Deprecated) Create a new WLAN.post
    • (Deprecated) Update an existing WLAN and clean up unsupported fields.patch
    • (Deprecated) Update an existing WLAN.put
    • Delete an existing WLAN.delete
    • Get the information of an existing WLAN.get
    • Create a new WLAN.post
    • Update an existing WLAN and clean up unsupported fields.patch
    • Update an existing WLAN.put
    • Get WLAN list of an UI group.get
    • Get WLAN default configuration.get
    • Get WLAN access rule protocol map.get
    • Get WLAN access rule services.get
    • Get the information of an existing WLAN.get
    • Create a new WLAN.post
    • Update an existing WLAN.put
    • Delete an existing WLAN.delete
    • Get hotspot list of an UI group or swarm.get
    • Get hotspot list of an UI group or swarm with mode nameget
    • Get hotspot default configuration.get
    • Get the information of an existing hotspot.get
    • Create a new hotspot.post
    • Update an existing hotspot.put
    • Delete an existing hotspot.delete
  • AP Settings
    • (Deprecated) Get an existing ap settings.get
    • (Deprecated) Update an existing ap settings.post
    • Get an existing ap settings.get
    • Update an existing ap settings.post
  • AP Configuration
    • Get AP configuration.get
    • Replace AP configuration.post
    • Get per AP setting.get
    • Replace per AP setting.post
    • Get variables config.get
    • Replace AP variables.post
    • Get dirty diff.get
    • Get System Config.get
    • Update system config.post
    • Get ARM configuration.get
    • Update ARM configuration.post
    • Get all Dot11g Radio Profiles.get
    • Get Dot11g radio profile.get
    • Update/Create Dot11g radio profile.post
    • Delete Dot11g radio profile.delete
    • Get all Dot11a Radio Profiles.get
    • Get Dot11a radio profile.get
    • Update/Create Dot11a radio profile.post
    • Delete an existing Dot11a radio profile.delete
  • Swarm Config
    • (Deprecated) Get an existing swarm config.get
    • (Deprecated) Update an existing swarm config.post
    • Get an existing swarm config.get
    • Update an existing swarm config.post
  • CX Configuration
    • Get Interfacesget
    • Update Interfacespost
    • Get LAGsget
    • Create/Update/Delete LAGspost
    • Get Loop Preventionget
    • Update Loop Preventionpost
    • Get Propertiesget
    • Update Propertiespost
    • Get Syslogget
    • Create/Update/Delete Syslogpost
    • Get VLANsget
    • Create/Update/Delete VLANspost
  • AOS-S
    • Get ports name for a group.get
    • Update ports name for a group.put
    • Get ports name for a device.get
    • Update ports name for a device.put
    • Get vlans with tagged, untagged and isolated ports for a group.get
    • Update vlans with tagged, untagged and isolated ports for a group.put
    • Get vlans with tagged, untagged and isolated ports for a device.get
    • Update vlans with tagged, untagged and isolated ports for a device.put

Deprecated Device Inventory

  • Devices
    • Get devices from device inventoryget
    • Add device using Mac and Serial numberpost
    • Get devices statsget
    • Verify device additionpost
    • Get status of refresh jobget
    • Schedule a job to refresh the device inventorypost
    • (Deprecated) Get devices from device inventoryget
    • (Deprecated) Add device using Mac and Serial numberpost
    • (Deprecated) Get devices statsget
  • Private Cloud Devices
    • Get device from device inventoryget

Firmware

  • Firmware Management
    • List Firmware Details of Swarmsget
    • Firmware Details of Swarmget
    • List Firmware Details of Devicesget
    • Firmware Details of Deviceget
    • List Firmware Versionget
    • Firmware Versionget
    • Firmware Statusget
    • Firmware Upgradepost
    • Cancel Scheduled Upgradepost
    • Set Firmware Compliance Version Customerpost
    • Set Firmware Compliance Versionpost
    • Get Firmware Compliance Versionget
    • Clear Firmware Compliance Versiondelete
    • Firmware Upgrade at MSP Levelpost
    • Firmware Upgrade at Customer Levelpost
    • Cancel Scheduled Upgrade at MSP Levelpost
    • Cancel Scheduled Upgrade at Customer Levelpost
    • Cancel Scheduled Upgrade at MSP Levelpost
    • Cancel Scheduled Upgrade at Customer Levelpost
    • List Model Familyget
    • Set Firmware Compliance Version for MSP customerpost
    • Get Firmware Compliance Version for MSP Customerget
    • Clear Firmware Compliance Version for MSP Customerdelete
    • Set Firmware Compliance Version for Tenantpost
    • Get Firmware Compliance Version for Tenantget
    • Clear Firmware Compliance Version for Tenantdelete
    • List Tenants of an MSP customerget

GDPR

  • GDPR
    • List gdprs opt out MAC clients for this customerget
    • Add Gdpr opt out clientpost
    • GDPR Opt out MACget
    • Delete Opt out Macdelete

Guest

  • Portals
    • Get all portals with limited dataget
    • Create a new guest portal profilepost
    • Get preview url of guest portal profileget
    • Get guest portal profileget
    • Update guest portal profileput
    • Delete guest portal profiledelete
  • Visitors
    • Get all visitors created against a portalget
    • Create a new guest visitor of a portalpost
    • Get guest visitor accountget
    • Update guest visitor accountput
    • Delete guest visitor accountdelete
  • Sessions
    • Get all sessions of a ssidget
  • Wlans
    • Get all guest wlansget
  • Troubleshoot
    • Check if guest is enabled for current user.get
    • Provision cloud guest for current customerpost
  • WiFi4EU
    • WiFi4EU Statuspost
  • Summary
    • Get summary statisticsget

Deprecated Licensing

  • Subscriptions
    • (Deprecated) Get user subscription keysget
    • (Deprecated) Get subscription statsget
    • (Deprecated) Get enabled services for customerget
    • (Deprecated) Assign subscription to a devicepost
    • (Deprecated) Unassign subscription to a devicepost
    • (Deprecated) Get services licensing configget
    • Standalone customer API:- Assign licenses to all devices.post
    • Standalone customer API:- Un-assign licenses to all devices for given services.delete
    • MSP API:- Assign licenses to all the devices owned by tenant customers.post
    • MSP API:- Remove service licenses to all the devices owned by tenants and MSP.delete
  • Auto-License
    • (Deprecated) Get services and corresponding license token availability status.get
    • (Deprecated) Get the services which are auto enabled.get
    • (Deprecated) Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.post
    • (Deprecated) Standalone Customer API:- Disable auto licensing for given services.delete
    • (Deprecated) Get auto enabled services for msp or tenant customer.get
    • (Deprecated) MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.post
    • (Deprecated) MSP API:- Disable auto license settings at msp and its tenant level for given services.delete

Monitoring

  • Network
    • List all Networksget
    • List all Networksget
    • Get Network detailsget
    • Get Network detailsget
    • WLAN Network Bandwidth usageget
    • WLAN Network Bandwidth usageget
  • AP
    • List Access Pointsget
    • List Access Pointsget
    • List BSSIDsget
    • List BSSIDsget
    • AP Detailsget
    • Delete APdelete
    • AP Neighbouring Clientsget
    • AP RF Summaryget
    • AP RF Summaryget
    • AP RF Summaryget
    • AP uplink historyget
    • AP Bandwidth Usageget
    • AP Bandwidth Usageget
    • AP Bandwidth Usageget
    • Top N AP Detailsget
    • Top N AP Detailsget
  • Swarm
    • Top N Swarms By Bandwidth Usageget
    • Top N Swarms By Clients Countget
    • List Swarmsget
    • Swarm Detailsget
  • Client
    • List Wireless Clientsget
    • List Wired Clientsget
    • List Unified Clients (Wired/Wireless). Option to choose Connected/Failed Clientsget
    • Client Detailsget
    • Wireless Client Detailsget
    • Wireless Client Mobility Trailget
    • Wired Client Detailsget
    • Client Bandwidth Usageget
    • Top N Clientsget
    • Total Clients Countget
  • VPN
    • Vpn Detailsget
    • Swarm VPN statsget
    • Swarm VPN statsget
    • Swarm VPN statspost
  • MobilityController
    • List Mobility Controllersget
    • Mobility Controller Detailsget
    • Delete Mobility Controllerdelete
    • Mobility Controllers Ports Bandwidth Usageget
    • Mobility Controllers Ports Detailsget
    • Mobility Controllers VLAN detailsget
    • List Mobility Controllersget
    • Mobility Controller Detailsget
    • Delete Mobility Controllerdelete
  • Gateway
    • Gateway Listget
    • Gateway Detailsget
    • Delete Gatewaydelete
    • Gateway Uplink Detailsget
    • Gateway Uplink Bandwidth Usageget
    • Gateway Uplink tunnel statsget
    • Gateway Uplink WAN compression statsget
    • Gateway Uplink distributionget
    • Gateway Ports Bandwidth Usageget
    • Gateway Ports Detailsget
    • Gateway Port Errorsget
    • Gateway Tunnels Detailsget
    • Gateway DHCP Clients informationget
    • Gateway DHCP Pools detailsget
    • Gateway VLAN detailsget
  • Label
    • List Labelsget
    • Create Labelpost
    • List Default Labelsget
    • Label detailsget
    • Update Labelpatch
    • Delete Labeldelete
    • Associate Label to devicepost
    • Unassociate Label from devicedelete
    • Associate Label to a list of devicespost
    • Unassociate a label from a list of devicesdelete
    • List Label Categoriesget
  • Site
    • List Sitesget
    • Create Sitepost
    • Site detailsget
    • Update Sitepatch
    • Delete Sitedelete
    • Associate Site to devicepost
    • Unassociate Site from devicedelete
    • Associate Site to a list of devicespost
    • Unassociate a site from a list of devicesdelete
  • Switch
    • List Switchesget
    • Get vlan info of the switchget
    • Get vlan info for CX switchget
    • Get vlan info of the switch stackget
    • Get vlan info of the CX switch stackget
    • Get switch port poe infoget
    • Get switch port poe info for CX switchget
    • Get switch poe infoget
    • Get switch poe info for CX switchget
    • Get switch vsx info for CX switchget
    • Switch Bandwidth Usageget
    • Top N Switchesget
    • Switch Detailsget
    • Delete Switchdelete
    • Switch Ports Detailsget
    • Get ports details for CX switchget
    • Switch Chassis Detailsget
    • Switch Ports Bandwidth Usageget
    • Ports Bandwidth Usage for CX Switchget
    • Switch Ports Errorsget
    • CX Switch Ports Errorsget
    • Switch Stack Port Detailsget
    • CX Switch Stack Port Detailsget
    • List Switch Stacksget
    • Switch Stack Detailsget
    • Delete Switch Stackdelete
  • Events
    • (Deprecated) List Eventsget
    • List Eventsget

MSP

  • Customers
    • Get list of customers under the MSP account based on limit and offsetget
    • Create a new customerpost
    • Get details of customerget
    • Update a customerput
    • Delete a customerdelete
  • Users
    • Get list of users under the MSP account based on limit and offsetget
    • Get list of users under the Customer account based on limit and offsetget
  • Resources
    • Get the resource under the MSPget
    • Edit an existing resource for the MSPput
  • Devices
    • Get list of devices and licenses under the Customer account based on limit and offsetget
    • Move a device to an end-customerput
    • Get list of devices and licenses under the MSP account based on limit and offsetget
  • Groups
    • Get list of customers mapped to MSP group based on limit and offset.get

Network Health

  • Network Health
    • Get data for all labelsget
    • Get data for all sitesget

Notification

  • Types
    • List Typesget
  • Settings
    • List Settingsget
    • Add settingspost
    • Delete Settingsdelete
    • Update settings detailsput
    • Get Customer account level Settingsget
    • Update customer settingsput
  • Notification
    • Get notifications count by severityget
    • List Notificationsget
    • Acknowledge Notifications by ID List / Allpost
    • Acknowledge Notificationpatch

New Device Inventory

  • Devices
    • Get devices from device inventoryget
    • Add device using Mac and Serial numberpost
    • Delete devices using Serial numberdelete
    • Get devices statsget
    • Verify device additionpost
    • Get status of refresh jobget
    • Schedule a job to refresh the device inventorypost
    • Get Archived devices from device inventoryget
    • Archive devices using Serial listpost
    • Unarchive devices using Serial listpost
  • Private Cloud Devices
    • Get device from device inventoryget
  • MSP Devices
    • A filterable paginated response of a list of devices and licenses under the customer account based on the provided limit and offset parametersget
    • assign the device to the end-customerput
    • A filterable paginated response of a list of devices and licenses under the MSP account based on the provided limit and offset parameters.get

RAPIDS

  • Rogues
    • List Rogue APsget
    • List Interfering APsget
    • List suspect APsget
    • List neighbor APsget
    • Delete a roguedelete
  • SSIDs
    • List Allowed SSIDsget
    • Add Allowed SSIDspost
    • Delete Allowed SSIDsdelete
    • List Blocked SSIDsget
    • Add Blocked SSIDspost
    • Delete Blocked SSIDsdelete
  • WIDS
    • List Infrastructure Attacksget
    • List Client Attacksget
    • WIDS Eventsget

Reporting

  • Reports
    • Scheduled Reportsget
    • Generated Reportsget
    • Scheduled Reportsget
    • Generated Reportsget
  • SDWAN Reports
    • SDWAN DPS policy compliance reportget

Device Routing - BGP

  • Neighbor
    • List BGP neighbor Informationget
    • Get BGP neighbor detailed informationget
    • Reset/clear BGP neighbor sessionput
    • List of routes learned form a BGP neighborget
    • List of routes advertised to a BGP neighborget
  • Route
    • List BGP routesget

Device Routing - Overlay

  • Connection
    • Get information about overlay control connectionget
    • Reset overlay control connectionput
  • Interface
    • List of overlay interfaces (tunnels)get
  • RouteLearned
    • List of learned routes from overlayget
  • RouteLearnedBest
    • List of best learned routes from overlayget
  • RouteAdvertised
    • List of advertised routes to overlayget

Device Routing - OSPF

  • Area
    • List OSPF Area Informationget
  • Interface
    • List OSPF Interface Informationget
  • Neighbor
    • List OSPF neighbor Informationget
  • LinkStateDatabase
    • List OSPF Link State Database Informationget

Device Routing - RIP

  • Interface
    • List RIP interfacesget
  • Neighbor
    • List RIP neighborsget
    • List of routes learned from a RIP neighborget
  • Route
    • List RIP routesget

Device Routing - RoutingTable

  • Route
    • Get routesget
    • Get legacy routesget

Topology

  • Topology
    • Get topology details of a site.get
    • Get details of a device.get
    • Get details of an edge.get
    • Get details of an edge for the selected source and destination.get
    • Get details of an uplink.get
    • Get tunnel details.get
    • Get neighbor details reported by AP via LLDP.get
    • Get vlan list of a site.get
    • Get list of unreachable devices in a site.get

Troubleshooting

  • Troubleshooting
    • List Troubleshooting Commandsget
    • Start Troubleshooting Sessionpost
    • Get Troubleshooting Outputget
    • Clear Troubleshooting Sessiondelete
    • Get Troubleshooting Session IDget
    • Export Troubleshooting Outputget
    • Initiate Running Config Backup For A Single Devicepost
    • Get list of backups associated with the device serial with the given prefixget
    • Initiate Running Config Backup For All Devices In A Grouppost
    • Get list of backups associated with the device serialget
    • Fetch the backup stored against the given nameget
  • Action Command
    • Action command for enroll est certificatepost

User Management

  • Users
    • Create a user accountpost
    • (Deprecated) Create a user accountpost
    • Change user passwordpost
    • Reset user passwordpost
    • Get user account details specified by user idget
    • Get user account details specified by user idget
    • Update a user accountpatch
    • (Deprecated) Get User account details specified by user idget
    • Delete a user accountdelete
    • (Deprecated) Update a user account specified by user idpatch
    • List user accountsget
    • Create a user accountpost
    • update user account details specified by user id.Providing info on account setting app is mandatory in this API along with other subscribed apps.Scope must be given only for NMS app. For non-nms apps such as account setting refer the parameters in the example json payload.patch
    • Get user account details specified by user idget
    • delete user account details specified by user iddelete
    • Change user passwordpost
    • Reset user passwordpost
  • Users_bulk_support
    • Create multiple users accountpost
    • Update multiple users accountpatch
    • Delete multiple users accountdelete
    • Get task statusget
  • Roles
    • Get all user rolesget
    • Create a user rolepost
    • Get User role detailsget
    • Delete a user roledelete
    • Update a user rolepatch
    • Get list of all rolesget
    • Get Role detailsget
    • Delete a roledelete
    • Update a rolepatch
    • Create a role in an apppost
  • Bulk Users
    • Create multiple users account. The max no of accounts that can be created at once is 10.post
    • Update multiple users account. The max no of accounts that can be updated at once is 10.Providing role on account setting app is mandatory in this API along with other subscribed apps. Scope must be given only for NMS app. For non-nms apps such as account setting refer the parameters in the example json payload.patch
    • Delete multiple users account. The max no of accounts that can be deleted at once is 10.delete
    • Get task statusget

VisualRF

  • Client Location
    • Get location of a specific clientget
    • Get a specific floor and location of all its clientsget
  • Rogue Location
    • Get location of a specific rogue access pointget
    • Get a specific floor and location of all its rogue access pointsget
  • Floorplan
    • (Deprecated) Get list of all campusesget
    • (Deprecated) Get a specific campus and its buildingsget
    • Get a specific building and its floorsget
    • Get details of a specific floorget
    • Get background image of a specific floorget
    • Get a specific floor and location of all its access pointsget
    • Get location of a specific access pointget

New Licensing

  • Subscriptions
    • Get user subscription keysget
    • Get subscription statsget
    • Assign subscription to a devicepost
    • Unassign subscription to a devicepost
    • Get enabled services for customerget
    • Get services licensing configget
    • Standalone customer API:- Assign licenses to all devices.post
    • Standalone customer API:- Un-assign licenses to all devices for given services.delete
    • MSP API:- Assign licenses to all the devices owned by tenant customers.post
    • MSP API:- Remove service licenses to all the devices owned by tenants and MSP.delete
  • Auto-License
    • Get services and corresponding license token availability status.get
    • Get the services which are auto enabled.get
    • Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.post
    • Standalone Customer API:- Disable auto licensing for given services.delete
    • Get auto enabled services for msp or tenant customer.get
    • MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.post
    • MSP API:- Disable auto license settings at msp and its tenant level for given services.delete

Webhook

  • Webhooks
    • List webhooksget
    • Add Webhookpost
    • Webhook setting for a specific itemget
    • Delete Webhooksdelete
    • Update webhook settingsput
    • Get Webhook Tokenget
    • Refresh the webhook tokenput
    • Test for webhook notificationget

AIOps

  • Wi-Fi Connectivity Dashboard
    • Wi-Fi Connectivity at Globalget
    • Wi-Fi Connectivity at Siteget
    • Wi-Fi Connectivity at Groupget
  • AI Insights List
    • List AI Insights for a Networkget
    • List AI Insights for a Siteget
    • List AI Insights for an APget
    • List AI Insights for a Clientget
    • List AI Insights for a Gatewayget
    • List AI Insights for a Switchget
  • AI Insight Details
    • AI Insight Details for a Networkget
    • AI Insight Details for a Siteget
    • AI Insight Details for an APget
    • AI Insight Details for a Clientget
    • AI Insight Details for a Gatewayget
    • AI Insight Details for a Switchget

ACP Audit Trail

  • audit
    • Get all audit logsget
    • Get details of an audit logget

Audit Event Logs

  • audit
    • Get all audit events for all groupsget
    • Get details of an audit event/logget

Authentication & Policy

  • Client Policy
    • Fetch network access policy for registered clients.get
    • Configure or update network access policy for registered clients.put
    • Delete existing Client Policy.delete
  • Client Registration
    • Fetch list of registered clients.get
    • Add registered client.post
    • Delete registered client.delete
    • Update registered client name.patch
  • User Policy
    • Fetch policy that allows wireless network access for users.get
    • Configure policy to allow wireless network access for users.put
    • Delete existing User Policy.delete

Client Match

  • Status
    • Get the status of Client Match for a tenantget
    • Enable or disable Client Match for a particular tenant.post
    • Get the status of Client Match Load Balancer for a tenantget
    • Enable or disable Client Match Load Balancer for a particular tenant.post
  • Unsteerable
    • Get all unsteerable entries for a tenantget
    • Get the unsteerable state of a clientget
    • Set the unsteerable state of a clientpost
    • Delete the unsteerable state of a clientdelete

Device Management

  • ActionCommand
    • Generic commands for devicepost
    • Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
    • Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
    • Generic commands for swarmpost
    • Disconnect Userpost
    • Speed Testpost
    • Statusget
    • Move the devices across customerspost
  • Pre Provisioned Group
    • Assign Pre-Provisioned Grouppost
  • DMS
    • Trigger activate sync for given MobilityMasterpost
    • Statically assign Mobility Master to Mobility Device.post
    • Get assigned Mobility Master to Mobility Device.get
    • Delete Mobility Master to Mobility Device mappingdelete
  • PSKeys
    • (Deprecated) Get ps keys from device inventoryget
    • (Deprecated) Add PS Keyspost
    • (Deprecated) Delete PS Keys using namedelete
  • Controller Management
    • (Deprecated) Get list of controller discovery details from device inventoryget
    • (Deprecated) Add Controller Profile to Device Inventorypost
    • (Deprecated) Update Controller Profile from Device Inventoryput
    • (Deprecated) Delete controller profile using Serial numberdelete
    • (Deprecated) Get controller settings using Serialget
    • (Deprecated) Add HTTPS Connection profile detailspost
    • (Deprecated) Update HTTPS Connection profile detailsput
    • (Deprecated) Get list of HTTPS Connection profile detailsget
    • (Deprecated) Get https connection profile details using nameget
    • (Deprecated) Add SNMP Connection profile detailspost
    • (Deprecated) Update SNMP Connection profile detailsput
    • (Deprecated) Get list of SNMP Connection profile detailsget
    • (Deprecated) Get SNMP connection profile details using nameget

DPS Monitoring

  • DPS
    • Gets DPS Policy stats for a given BOC.get
    • Gets DPS Policy stats for a given BOC.get
    • DPS Key Performance Indicator for a given BOC.get
    • DPS Compliance percentage of all DPS Policies for a given BOC.get
    • DPS Compliance Status of all DPS Policies for a given BOC.get
    • Gets DPS Policy Event Logs for a given BOC.get
    • Gets DPS Compliance stats for a given Site.get

Install Manager

  • Installers
    • Invite a new installerpost
  • Sites
    • For a given set of site names, assign Group Names for each device typepost

IOT Operations - Appstore

  • App Store
    • Search appsget
    • Find all installed appsget
    • Count all installed appsget
    • Get Appget
    • Get App Iconget
    • Install apppost
    • Edit Installed app configurationpost
    • Delete appdelete
    • Upgrade apppost
    • Developer appsget
    • Edit Developer installed app configurationpost
    • Get Developer Appget
    • Get Developer App Iconget
    • Install Developer apppost
    • Delete Developer appdelete
    • Upgrade developer apppost
    • Developer infoget
    • Find Recommended Appsget

IOT Operations - Device

  • Devices
    • Return Pageable List of all devicesget
    • Return Pageable List of all devicesget
    • Return the count of devices with one or more device classesget
    • Return the count of devicesget
    • Return the count of devices by Device Classget
    • Return the count of devices reporters by Collectorget
    • <