Jump to Content
Home
Guides
API Reference
New HPE ANW Central
HPE ANW Central
AOS-CX
AOS 8
User Experience Insight
ClearPass Policy Manager
HPE ANW Fabric Composer
HPE ANW EdgeConnect SD-WAN
v2.5.7
v2.5.8
Guides
API Reference
GitHub
Airheads Developer Community
Log In
API Reference
Guides
API Reference
GitHub
Airheads Developer Community
Log In
HPE ANW Central
v2.5.8
API Reference
Return a Gateway by cluster Id
Search
JUMP TO
ACP Audit Trail
audit
Get all audit logs
get
Get details of an audit log
get
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 SerialID
get
AIOps
Wi-Fi Connectivity Dashboard
Wi-Fi Connectivity at Global
get
Wi-Fi Connectivity at Site
get
Wi-Fi Connectivity at Group
get
AI Insights List
List AI Insights for a Network
get
List AI Insights for a Site
get
List AI Insights for an AP
get
List AI Insights for a Client
get
List AI Insights for a Gateway
get
List AI Insights for a Switch
get
AI Insight Details
AI Insight Details for a Network
get
AI Insight Details for a Site
get
AI Insight Details for an AP
get
AI Insight Details for a Client
get
AI Insight Details for a Gateway
get
AI Insight Details for a Switch
get
AirGroup
Summary
Get AirGroup Traffic Summary in terms of Packets
get
Retrieves device summary
get
Trend
Get temporal data about AirGroup based on the parameter passed
get
List
Retrieves list of labels
get
Get all the uncached services encountered by AirGroup
get
Retrieves a list of all hostnames
get
Distribution
Retrieves a summary of all the services queried for.
get
Retrieves a summary of the servers connected to AirGroup
get
Stats
Retrieves the suppression factor
get
AirMatch
Radio
Get reporting radio of a specific radio MAC
get
Get all reporting radio for a customer
get
Get nbr pathloss of a neighbor MAC heard by a specific radio MAC
get
Get all nbr pathloss for a customer and band
get
Get RF events of a specific radio MAC
get
Get radar and noise RF events of a specific radio MAC
get
Get history of a specific radio MAC
get
Get all nbr pathloss for a customer and radio MAC
get
Get all static radios for a customer
get
Get EIRP distribution
get
Get EIRP reasons
get
Get information about radio
get
Get neighbor stats information
get
Get all RF events of a tenant id
get
Get all radar and noise RF events of a tenant
get
Get EIRP reasons
get
Get board limits of a specific radio MAC
get
Get radio neighbor list
get
AP
Get AP info of a specific AP ethernet MAC
get
Get AP info for all AP's
get
Get number of AP's and AP models
get
Returns all device (AP) running configuration for a customer
get
Returns device (AP) running configuration
get
Change a device running config
put
Returns device (AP) running configuration
get
Change a device running config
put
Returns all device (AP) running configuration for a customer
get
Get feasibility ap info of a specific AP ethernet MAC
get
Get AP neighbor list
get
Get AP neighbor list
get
Telemetry
Bootstrap
post
Purge
post
Solution
Get optimizations for tenant
get
Run the algorithm for the solution
post
Get solution of a specific radio MAC
get
Get all solutions for a customer
get
Get optimizations for tenant's requested partition
get
Miscellaneous
Gets radios deployment status
get
Returns all device (AP) running configuration for all customers
get
Returns device (AP) running configuration
get
Schedule
RMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour details
post
RMQ message triggers a runnow job for a certain tenant
post
Get the schedule of all jobs computed by the scheduler
get
Get the jobs to be sent to deployer for AirMatch solution deployment
get
Get the list of jobs generated by scheduler
get
Get the list of unique timezone and deploy hours per tenant
get
Trigger - RMQ message with on-demand compute for a provided tenant id
post
Radio feasibility
Trigger update of radio feasibility
put
Get radio feasibility of a specific radio MAC
get
Get all radio feasibility for a customer
get
Get radio_feasibility of a specific radio MAC
get
Get all radio feasibility for a customer
get
Get feasibility radio info of a specific radio MAC
get
Deployer
Get a list of pending deployments for a tenant id
get
Trigger computation complete message
post
RMQ message generates southbound test action-msg
post
Trigger test-config update
post
RF domain
Get partition information
get
Start partition process
post
AppRF
Overview
(Deprecated) Gets Top N Apprf Statistics
get
Gets Top N Apprf Statistics (V2 Version)
get
Applications
Gets Top N Applications
get
Web Categories
Gets Top N Web categories
get
App Categories
Gets Top N App categories
get
Web Reputations
Gets Top Web Reputations
get
AppRF IAP Meta Info
Gets Web Reputation id to name mapping
get
Gets Application id to name mapping
get
Gets Application Category id to name mapping
get
Gets Web Category id to name mapping
get
Audit Event Logs
audit
Get all audit events for all groups
get
Get details of an audit event/log
get
Authentication & Policy
Authentications and Sessions
Fetch list of authentications using Aruba Air Pass.
get
Fetch list of authentications using Cloud Identity.
get
Fetch details of a specific authentication using either Cloud Identity or Aruba Air Pass.
get
Fetch list of sessions using Aruba Air Pass.
get
Fetch list of sessions using Cloud Identity.
get
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
Reset Client Policy.
put
Client Registration
Fetch list of registered clients.
get
Add registered client.
post
Delete registered client.
delete
Update registered client name.
patch
Wi-Fi Easy Connect
Fetch list of registered clients.
get
Register a client.
post
Update registered client with bootstrapping key.
put
Delete registered client.
delete
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
Reset User Policy.
put
Download
Fetch all Named MPSK as a CSV file.
get
Fetch all Mac Registrations as a CSV file.
get
MPSK Networks Configs
Read all configured MPSK networks.
get
Create an MPSK network config
post
Read one MPSK network config.
get
Edit an MPSK network config
put
Delete an MPSK network configuration.
delete
Read all named MPSK
get
Add a named MPSK config
post
Read a named MPSK config
get
Edit a Named MPSK Config
put
Delete a Named MPSK Config
delete
Partially Edit a Named MPSK Config
patch
Read MPSK Usage Stats
get
File Upload
Upload file
post
Read errors in last file upload
get
Read upload status of last file upload
get
Terminate Upload
put
Upload file
post
Read errors in last file upload
get
Read upload status of last file upload
get
Terminate Upload
put
MAC Registration
Fetch list of mac registrations.
get
Add mac registration.
post
Delete registered mac registration.
delete
Update registered client name.
patch
User Management
Fetches certificate details of a user
get
Revoke a user's device certificate
post
Ble Beacon Service
BleBeaconService
Retrieve ble configured beacons
get
Retrieve ble running beacons
get
Retrieve ble beacon profiles
get
Config ble beacon profile
post
Edit ble beacon profile
post
Delete ble beacon profile
delete
Update one device beacon config
post
Delete one device beacon config
delete
Client Match
Status
Get the status of Client Match for a tenant
get
Enable or disable Client Match for a particular tenant.
post
Get the status of Client Match Load Balancer for a tenant
get
Enable or disable Client Match Load Balancer for a particular tenant.
post
Get the status of Client Match Band Steer to 6GHz for a tenant
get
Enable or disable Client Match Band Steer to 6GHz for a particular tenant.
post
Unsteerable
Get all unsteerable entries for a tenant
get
Get the unsteerable state of a client
get
Set the unsteerable state of a client
post
Delete the unsteerable state of a client
delete
Cloud Connect
Cloud Connect
Update Custom cloud provider endpoint config
put
Create Custom cloud provider endpoint config
post
Delete Custom cloud provider endpoint config
delete
Update Zscaler cloud provider endpoint config
put
Create Zscaler cloud provider endpoint config
post
Delete Zscaler cloud provider endpoint config
delete
Update AWS cloud provider endpoint config
put
Create AWS cloud provider endpoint config
post
Delete AWS cloud provider endpoint config
delete
Update Azure cloud provider endpoint config
put
Create Azure cloud provider endpoint config
post
Delete Azure cloud provider endpoint config
delete
Update Prisma cloud provider endpoint config
put
Create Prisma cloud provider endpoint config
post
Delete Prisma cloud provider endpoint config
delete
Trigger cloud provider endpoint scan.
get
Get all Cloud Provider endpoints.
get
Get Zscaler node scan details.
get
Get configured vlan list for each cloud connect endpoint.
get
Get config summary for configured groups.
get
Get the list of valid Tunnel Policy configurations
get
Get the list of all Tunnel Policy Configurations
get
Get the Tunnel Policy Configuration for policy_name
get
Updates an existing Tunnel Policy with name as policy_name
put
Creates a new Tunnel Policy with name as policy_name
post
Delete Tunnel Policy with name as policy_name
delete
Get the Custom Cloud Account Configuration for account_name
get
Updates an existing Custom Cloud Account with name as account_name
put
Creates a new Custom Cloud Account with name as account_name
post
Delete Custom Cloud Account with name as account_name
delete
Get the Prisma Account Configuration for account_name
get
Updates an existing Prisma Cloud Account with name as account_name
put
Creates a new Prisma Cloud Account with name as account_name
post
Delete Prisma Cloud Account with name as account_name
delete
Configuration
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
Delete existing group.
delete
Pre Provisioned Group
Pre Provision a group to the device
post
Assign Pre-Provisioned Group
post
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
(Deprecated) Set Username, password required for establishing SSH connection to switch.
post
Variables
Get template variables for a device.
get
Replace all or delete some of the template variables for a device.
put
Create template variables for a device.
post
Delete all of the template variables for a device.
delete
Update template variables for a device.
patch
Get template variables for all devices, Response is sorted by device serial.
get
Replace all or delete some of the template variables for all devices.
put
Create template variables for all devices.
post
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
Update a certificate for non msp customer.
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 clients
post
Delete denylist clients
delete
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) Update an existing WLAN.
put
(Deprecated) Create a new WLAN.
post
Delete an existing WLAN.
delete
(Deprecated) Update an existing WLAN and clean up unsupported fields.
patch
Get the information of an existing WLAN.
get
Update an existing WLAN.
put
Create a new WLAN.
post
Update an existing WLAN and clean up unsupported fields.
patch
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
Update an existing WLAN.
put
Create a new WLAN.
post
Delete an existing WLAN.
delete
Get hotspot list of an UI group or swarm or device.
get
Get hotspot list of an UI group or swarm or device with mode name
get
Get hotspot default configuration.
get
Get the information of an existing hotspot.
get
Update an existing hotspot.
put
Create a new hotspot.
post
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
Get ssh credential in group level.
get
Update ssh credential in group level.
post
Get ssh credential in device level.
get
Update ssh credential in device level.
post
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
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
Get admin SSH details of a group.
get
Update admin SSH details of a group.
put
Get admin SSH details of a device.
get
Update admin SSH details of a device.
put
Get system time details for a group.
get
Update system time details for a group.
put
Get system time details for a device.
get
Update system time details for a device.
put
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
Deprecated Device Inventory
Devices
Get devices from device inventory
get
Add device using Mac and Serial number
post
Get devices stats
get
Verify device addition
post
Get status of refresh job
get
Schedule a job to refresh the device inventory
post
(Deprecated) Get devices from device inventory
get
(Deprecated) Add device using Mac and Serial number
post
(Deprecated) Get devices stats
get
Private Cloud Devices
Get device from device inventory
get
Deprecated Licensing
Subscriptions
(Deprecated) Get user subscription keys
get
(Deprecated) Get subscription stats
get
(Deprecated) Get enabled services for customer
get
(Deprecated) Assign subscription to a device
post
(Deprecated) Unassign subscription to a device
post
(Deprecated) Get services licensing config
get
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
Device Management
ActionCommand
Generic commands for device
post
Generic Action Command for bouncing interface or POE (power-over-ethernet) port
post
Generic Action Command for bouncing interface or POE (power-over-ethernet) port
post
Generic commands for swarm
post
Disconnect User
post
Speed Test
post
Status
get
DMS
Statically assign Mobility Master to Mobility Device.
post
Get assigned Mobility Master to Mobility Device.
get
Delete Mobility Master to Mobility Device mapping
delete
Device Replacement
Offline Devices
Get all offline devices
get
Request Replacement
To request device replacement
post
Check Compliance
To check compliance
post
Initiate Replacement
To initiate device replacement
post
Cancel Replacement
To cancel device replacement
post
Devices Under Replacement
To get devices under replacement
get
Device status
To check device status
get
Device count
To get device count for a Tenant/Standalone account
get
MSP Replacement Count
Count of devices under replacement for a MSP customer
get
Get MSP customers
Get all tenants under that MSP account
get
MSP replacement details
Get replacement details of all tenants under that MSP account
get
Device Routing - BGP
Neighbor
List BGP neighbor Information
get
Get BGP neighbor detailed information
get
Reset/clear BGP neighbor session
put
List of routes learned form a BGP neighbor
get
List of routes advertised to a BGP neighbor
get
Route
List BGP routes
get
Device Routing - OSPF
Area
List OSPF Area Information
get
Interface
List OSPF Interface Information
get
Neighbor
List OSPF neighbor Information
get
LinkStateDatabase
List OSPF Link State Database Information
get
Device Routing - Overlay
Connection
Get information about overlay control connection
get
Reset overlay control connection
put
Interface
List of overlay interfaces (tunnels)
get
RouteLearned
List of learned routes from overlay
get
RouteLearnedBest
List of best learned routes from overlay
get
RouteAdvertised
List of advertised routes to overlay
get
Device Routing - RIP
Interface
List RIP interfaces
get
Neighbor
List RIP neighbors
get
List of routes learned from a RIP neighbor
get
Route
List RIP routes
get
Device Routing - RouteTable
Route
Get routes
get
Get legacy routes
get
Firmware
Firmware Management
List Firmware Details of Swarms
get
Firmware Details of Swarm
get
List Firmware Details of Devices
get
Firmware Details of Device
get
List Firmware Version
get
Firmware Version
get
Firmware Status
get
Firmware Upgrade
post
Cancel Scheduled Upgrade
post
Set Firmware Compliance Version Customer
post
Get Firmware Compliance Version
get
Set Firmware Compliance Version
post
Clear Firmware Compliance Version
delete
Firmware Upgrade at MSP Level
post
Firmware Upgrade at Customer Level
post
Cancel Scheduled Upgrade at MSP Level
post
Cancel Scheduled Upgrade at Customer Level
post
Cancel Scheduled Upgrade at MSP Level
post
Cancel Scheduled Upgrade at Customer Level
post
List Model Family
get
Get Firmware Compliance Version for MSP Customer
get
Set Firmware Compliance Version for MSP customer
post
Clear Firmware Compliance Version for MSP Customer
delete
Get Firmware Compliance Version for Tenant
get
Set Firmware Compliance Version for Tenant
post
Clear Firmware Compliance Version for Tenant
delete
List Firmware Details of a Tenant
get
GDPR
GDPR
List gdprs opt out MAC clients for this customer
get
Add Gdpr opt out client
post
GDPR Opt out MAC
get
Delete Opt out Mac
delete
Guest
Portals
Get all portals with limited data
get
Create a new guest portal profile
post
Get preview url of guest portal profile
get
Get guest portal profile
get
Update guest portal profile
put
Delete guest portal profile
delete
Visitors
Get all visitors created against a portal
get
Create a new guest visitor of a portal
post
Get guest visitor account
get
Update guest visitor account
put
Delete guest visitor account
delete
Sessions
Get all sessions of a ssid
get
Wlans
Get all guest wlans
get
Troubleshoot
Check if guest is enabled for current user.
get
Provision cloud guest for current customer
post
WiFi4EU
WiFi4EU Status
post
Summary
Get summary statistics
get
Install Manager
Installer
Invite a new installer
post
Get all installers
get
Delete an installer
delete
Update an installer
patch
QR code
Get QR code list
get
Create a QR code
post
Delete a QR code
delete
Update a QR code
patch
Sites
For a given set of site names, assign Group Names for each device type
post
Get all assigned group to sites list
get
Update site status
patch
IoT - App Developer Portal
Apps
List Published and Suspended Apps
get
List Draft Apps
get
Create App
post
Edit Draft App
post
Validate App Name
get
Delete App Version
delete
Withdraw App Version
post
Get App Version Details
get
Submit App
post
List App Versions
get
Container Image
List Images
get
Upload Image
post
List Images For Max Version
get
Validate Image Name
get
IoT - Appstore
App Store
Search apps
get
Find all installed apps
get
Count all installed apps
get
Get App
get
Get App Icon
get
Install app
post
Edit Installed app configuration
post
Delete app
delete
Upgrade app
post
Developer apps
get
Edit Developer installed app configuration
post
Get Developer App
get
Get Developer App Icon
get
Install Developer app
post
Delete Developer app
delete
Get the last 10 versions of an App
get
Upgrade developer app
post
Developer info
get
Find Recommended Apps
get
IoT - Device
Devices
Return Pageable List of all devices
get
Return Pageable List of all devices
get
Return the count of devices with one or more device classes
get
Return the count of devices
get
Return the count of devices by Device Class
get
Return the count of devices reporters by Collector
get
Return the count of devices by type
get
Return a time-series device count by collectorId
get
Return a device by Id
get
Return Pageable List of Attributes
get
Return the time-series from device
get
IoT - Iotgateway
iot_gateways
Return Pageable List of Gateways
get
Return Pageable List of Gateways
get
Return a Gateway by cluster Id
get
association
Return Pageable List of Gateways
get
Add Association
post
Delete Association
delete
Return Pageable List of Gateways
get
Returns security token associated with a collector
get
groups
Returns connector to group mapping
get
Group move
post
Group move
delete
IoT - Transport Profile
Transport Profile
Find transport profiles
get
Create a transport profile
post
Count transport profiles
get
Get a list of all device classes
get
Get a transport profile by id
get
Update a transport profile by id
put
Delete a transport profile by id
delete
MSP
Customers
Get list of customers under the MSP account based on limit and offset
get
(Deprecated) Create a new customer
post
Create a new customer
post
Update a customer
put
Get details of customer
get
(Deprecated) Update a customer
put
Delete a customer
delete
Get Country Code
Get list of country code
get
Users
Get list of users under the MSP account based on limit and offset
get
Get list of users under the Customer account based on limit and offset
get
Resources
Get the resource under the MSP
get
Edit an existing resource for the MSP
put
Devices
Get list of devices and licenses under the Customer account based on limit and offset, offset should be a multiple of the limit value
get
Move a device to an end-customer
put
Un-assign all devices from Tenant/end-customer.
put
Get list of devices and licenses under the MSP account based on limit and offset, offset should be a multiple of the limit value
get
Groups
Get list of customers mapped to MSP group based on limit and offset.
get
Monitoring
Network
List all Networks
get
Get Network details
get
WLAN Network Bandwidth usage
get
AP
List Access Points
get
List BSSIDs
get
AP Details
get
Delete AP
delete
AP RF Summary
get
AP Bandwidth Usage
get
Top N AP Details
get
Swarm
Top N Swarms By Bandwidth Usage
get
Top N Swarms By Clients Count
get
List Swarms
get
Swarm Details
get
Client
List Connected Wireless Clients
get
List Connected Wired Clients
get
List Unified Clients (Wired/Wireless). Option to choose Connected/Failed Clients
get
Client Details
get
Connected Wireless Client Details
get
Wireless Client Mobility Trail
get
Connected Wired Client Details
get
Client Bandwidth Usage
get
Top N Clients
get
Total Clients Count
get
VPN
Vpn Details
get
Swarm VPN stats
post
MobilityController
List Mobility Controllers
get
Mobility Controller Details
get
Delete Mobility Controller
delete
Mobility Controllers Ports Bandwidth Usage
get
Mobility Controllers Ports Details
get
Mobility Controllers VLAN details
get
List Mobility Controllers
get
Mobility Controller Details
get
Delete Mobility Controller
delete
Gateway
Gateway List
get
Gateway Details
get
Delete Gateway
delete
Gateway Uplink Details
get
Gateway Uplink Bandwidth Usage
get
Gateway Uplink tunnel stats
get
Gateway Uplink WAN compression stats
get
Gateway Uplink distribution
get
Gateway Ports Bandwidth Usage
get
Gateway Ports Details
get
Gateway Port Errors
get
Gateway Tunnels Details
get
Gateway DHCP Clients information
get
Gateway DHCP Pools details
get
Gateway VLAN details
get
Label
List Labels
get
Create Label
post
List Default Labels
get
Label details
get
Delete Label
delete
Update Label
patch
Associate Label to device
post
Unassociate Label from device
delete
Associate Label to a list of devices
post
Unassociate a label from a list of devices
delete
List Label Categories
get
Site
List Sites
get
Create Site
post
Site details
get
Delete Site
delete
Update Site
patch
Associate Site to device
post
Unassociate Site from device
delete
Associate Site to a list of devices
post
Unassociate a site from a list of devices
delete
Switch
List Switches
get
Get vlan info of the switch
get
Get vlan info for CX switch
get
Get vlan info of the switch stack
get
Get vlan info of the CX switch stack
get
Get switch port poe info
get
Get switch port poe info for CX switch
get
Get switch poe info
get
Get switch poe info for CX switch
get
Get switch vsx info for CX switch
get
Get lldp device neighbor info for CX switch
get
Get lldp device neighbor info for CX switch stack
get
Switch Bandwidth Usage
get
Top N Switches
get
Switch Details
get
Delete Switch
delete
Switch Ports Details
get
Get ports details for CX switch
get
Switch Chassis Details
get
Switch Ports Bandwidth Usage
get
Ports Bandwidth Usage for CX Switch
get
Switch Ports Errors
get
CX Switch Ports Errors
get
Switch Stack Port Details
get
CX Switch Stack Port Details
get
List Switch Stacks
get
Switch Stack Details
get
Delete Switch Stack
delete
Events
(Deprecated) List Events
get
List Events
get
Network Health
Network Health
Get data for all sites
get
New Device Inventory
Devices
Get devices from device inventory
get
Add device using Mac and Serial number
post
Delete devices using Serial number
delete
Get devices stats
get
Verify device addition
post
(Deprecated) Get status of refresh job
get
(Deprecated) Schedule a job to refresh the device inventory
post
Get Archived devices from device inventory
get
Archive devices using Serial list
post
Unarchive devices using Serial list
post
Private Cloud Devices
Get device from device inventory
get
MSP Devices
A filterable paginated response of a list of devices and licenses under the customer account based on the provided limit and offset parameters
get
assign the device to the end-customer
put
A filterable paginated response of a list of devices and licenses under the MSP account based on the provided limit and offset parameters.
get
New Licensing
Subscriptions
Get user subscription keys
get
Get subscription stats
get
Assign subscription to a device
post
Unassign subscription to a device
post
Get enabled services for customer
get
Get services licensing config
get
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
Notification
Types
List Types
get
Settings
List Settings
get
Add settings
post
Update settings details
put
Delete Settings
delete
Get Customer account level Settings
get
Update customer settings
put
Notification
Get notifications count by severity
get
List Notifications
get
Acknowledge Notifications by ID List / All
post
Acknowledge Notification
patch
Presence Analytics
Config
It retrieves RSSI threshold for passerby conversion, RSSI threshold for visitor conversion & dwelltime threshold for passerby to visitor conversion.
get
It configures RSSI threshold, dwelltime threshold for visitor & RSSI threshold for passerby.
post
It retrieves visitor RSSI threshold, passerby RSSI threshold, dwell time threshold, access points and site name for site level configuration.
get
it retrieves RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.
get
it configure RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.
post
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 values
get
Get loyalty indicator trends
get
Get loyalty visits of visitors in histogram
get
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 sites
get
PresenceStats
Get presence analytics trends.
get
Get presence analytics metrics aggregate values
get
Get presence analytics trends
get
License
Customer level device license status.
get
Enable or disable PA license.
post
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 sites
get
RAPIDS
Rogues
List Rogue APs
get
List Interfering APs
get
List suspect APs
get
List neighbor APs
get
List manually contained APs
get
WIDS
List Infrastructure Attacks
get
List Client Attacks
get
WIDS Events
get
Refresh API Token
refresh_api_token
Refresh API token
post
Reporting
Reports
Scheduled Reports
get
Generated Reports
get
Scheduled Reports
get
Generated Reports
get
SDWAN Reports
SDWAN DPS policy compliance report
get
SSO Configuration
SSO Support
Get saml metadata
get
Get domain list
get
Update IDP configuration
put
Add IDP config
post
Un-claim domain
delete
Extract Saml metadata from file
post
Service Airgroup
Aruba airgroup
Retrieve service-id for given custom service
get
Create/Update service-id for given custom service
put
Create service-id for given custom service
post
Delete service-id for given custom service
delete
Retrieve all service-ids in given custom service
get
Retrieve custom service for given name
get
Create/Update custom service for given name
put
Create custom service for given name
post
Delete custom service for given name
delete
Retrieve all custom service definitions
get
Retrieve entry in admin user-ids for given user_id
get
Create/Update entry in admin user-ids for given user_id
put
Create entry in admin user-ids for given user_id
post
Delete entry in admin user-ids for given user_id
delete
Retrieve all user-ids treated as admin users for device visibility
get
Retrieve Personal device visibility configuration
get
Create/Update Personal device visibility configuration
put
Create Personal device visibility configuration
post
Delete Personal device visibility configuration
delete
Retrieve service-id mapping for given standard service
get
Create/Update service-id mapping for given standard service
put
Create service-id mapping for given standard service
post
Retrieve all service-ids for given standard service
get
Retrieve standard service for given name
get
Create/Update standard service for given name
put
Create standard service for given name
post
Retrieve all standard Airgroup service definitions
get
Retrieve common_config
get
Retrieve disallowed role for given server
get
Create/Update disallowed role for given server
put
Create disallowed role for given server
post
Delete disallowed role for given server
delete
Retrieve all disallowed roles for given server
get
Retrieve allowed role for given server
get
Create/Update allowed role for given server
put
Create allowed role for given server
post
Delete allowed role for given server
delete
Retrieve all allowed roles for given server
get
Retrieve role restrictions for given airgroup server
get
Create/Update role restrictions for given airgroup server
put
Create role restrictions for given airgroup server
post
Delete role restrictions for given airgroup server
delete
Retrieve entry for serial_number in visibility ap_list for given server
get
Create/Update entry for serial_number in visibility ap_list for given server
put
Create entry for serial_number in visibility ap_list for given server
post
Delete entry for serial_number in visibility ap_list for given server
delete
Retrieve complete visibility ap_list for given server
get
Retrieve network visibility config for given airgroup server
get
Create/Update network visibility config for given airgroup server
put
Create network visibility config for given airgroup server
post
Delete network visibility config for given airgroup server
delete
Retrieve airgroup server config by mac_address
get
Create/Update airgroup server config by mac_address
put
Create airgroup server config by mac_address
post
Delete airgroup server config by mac_address
delete
Retrieve all configured airgroup servers
get
Retrieve airgroup_status
get
Create/Update airgroup_status
put
Create airgroup_status
post
Delete airgroup_status
delete
Retrieve General settings for given Global or Group
get
Create/Update General settings for given Global or Group
put
Create General settings for given Global or Group
post
Delete General settings for given Global or Group
delete
Retrieve disallowed vlan for given service
get
Create/Update disallowed vlan for given service
put
Create disallowed vlan for given service
post
Delete disallowed vlan for given service
delete
Retrieve all disallowed vlans for given service
get
Retrieve allowed vlan for given service
get
Create/Update allowed vlan for given service
put
Create allowed vlan for given service
post
Delete allowed vlan for given service
delete
Retrieve all allowed vlans for given service
get
Retrieve vlan restriction for given service at Global or group
get
Create/Update vlan restriction for given service at Global or group
put
Create vlan restriction for given service at Global or group
post
Delete vlan restriction for given service at Global or group
delete
Retrieve disallowed role for given service
get
Create/Update disallowed role for given service
put
Create disallowed role for given service
post
Delete disallowed role for given service
delete
Retrieve all disallowed roles for given service
get
Retrieve allowed role for given service
get
Create/Update allowed role for given service
put
Create allowed role for given service
post
Delete allowed role for given service
delete
Retrieve all allowed roles for given service
get
Retrieve role restrictions for given service at global or group
get
Create/Update role restrictions for given service at global or group
put
Create role restrictions for given service at global or group
post
Delete role restrictions for given service at global or group
delete
Retrieve airgroup service policy by name at Global or group
get
Create/Update airgroup service policy by name at Global or group
put
Create airgroup service policy by name at Global or group
post
Delete airgroup service policy by name at Global or group
delete
Retrieve all airgroup service policies at given Global or group
get
Retrieve complete Airgroup config for given Global or Group
get
Delete complete Airgroup config for given Global or Group
delete
Retrieve node_list by identifier node-type node-id
get
Service Airmatch
Aruba airmatch
Retrieve system
get
Create/Update system
put
Create system
post
Delete system
delete
Retrieve config
get
Create/Update config
put
Create config
post
Delete config
delete
Retrieve node_list by identifier node-type node-id
get
Service IDS IPS
Aruba ids ips
Retrieve SIEM server notification configuration
get
Create/Update SIEM server notification configuration
put
Create SIEM server notification configuration
post
Delete SIEM server notification configuration
delete
Retrieve SIEM server config for given siem_server_name
get
Create/Update SIEM server config for given siem_server_name
put
Create SIEM server config for given siem_server_name
post
Delete SIEM server config for given siem_server_name
delete
Retrieve config for all SIEM servers
get
Retrieve complete config for IDS/IPS
get
Create/Update complete config for IDS/IPS
put
Create complete config for IDS/IPS
post
Delete complete config for IDS/IPS
delete
Retrieve node_list by identifier node-type node-id
get
Service IPMS
Aruba ipms
Retrieve IP range by range_id for given address pool_name
get
Create/Update IP range by range_id for given address pool_name
put
Create IP range by range_id for given address pool_name
post
Retrieve all IP ranges for given address pool_name
get
Retrieve IP address pool for given pool_name
get
Create/Update IP address pool for given pool_name
put
Create IP address pool for given pool_name
post
Delete IP address pool for given pool_name
delete
Retrieve all IP address pools
get
Retrieve complete IPMS config
get
Retrieve node_list by identifier node-type node-id
get
Service Overlay Wlan
Aruba overlay wlan
Retrieve Cluster mapping by redundancy-type and group-name for given profile and type
get
Create/Update Cluster mapping by redundancy-type and group-name for given profile and type
put
Create Cluster mapping by redundancy-type and group-name for given profile and type
post
Delete Cluster mapping by redundancy-type and group-name for given profile and type
delete
Retrieve all Cluster mappings for given profile and type
get
Retrieve Cluster mapping for given profile and profile_type
get
Create/Update Cluster mapping for given profile and profile_type
put
Create Cluster mapping for given profile and profile_type
post
Delete Cluster mapping for given profile and profile_type
delete
Retrieve all Profile to Cluster mappings for given group
get
Retrieve Complete Overlay-wlan config for given group
get
Create/Update Complete Overlay-wlan config for given group
put
Create Complete Overlay-wlan config for given group
post
Delete Complete Overlay-wlan config for given group
delete
Retrieve node_list by identifier node-type node-id
get
Service RAPIDS
Aruba Rapids
Retrieve essid in include SSIDs for given classification rule_name
get
Create/Update essid in include SSIDs for given classification rule_name
put
Create essid in include SSIDs for given classification rule_name
post
Delete essid in include SSIDs for given classification rule_name
delete
Retrieve all include SSIDs for given classification rule_name
get
Retrieve essid in exclude SSIDs for given classification rule_name
get
Create/Update essid in exclude SSIDs for given classification rule_name
put
Create essid in exclude SSIDs for given classification rule_name
post
Delete essid in exclude SSIDs for given classification rule_name
delete
Retrieve all exclude SSIDs for given classification rule_name
get
Retrieve site by name in Site-Includes for given classification rule_name
get
Create/Update site by name in Site-Includes for given classification rule_name
put
Create site by name in Site-Includes for given classification rule_name
post
Delete site by name in Site-Includes for given classification rule_name
delete
Retrieve all sites in Site-Includes for given classification rule_name
get
Retrieve site by name in Site-Excludes for given classification rule_name
get
Create/Update site by name in Site-Excludes for given classification rule_name
put
Create site by name in Site-Excludes for given classification rule_name
post
Delete site by name in Site-Excludes for given classification rule_name
delete
Retrieve all sites in Site-Excludes for given classification rule_name
get
Retrieve match criteria for given classification rule_name
get
Create/Update match criteria for given classification rule_name
put
Create match criteria for given classification rule_name
post
Delete match criteria for given classification rule_name
delete
Retrieve Classification rule by rule_name
get
Create/Update Classification rule by rule_name
put
Create Classification rule by rule_name
post
Delete Classification rule by rule_name
delete
Retrieve all Classification rules
get
Retrieve complete RAPIDS configuration
get
Create/Update complete RAPIDS configuration
put
Create complete RAPIDS configuration
post
Delete complete RAPIDS configuration
delete
Retrieve node_list by identifier node-type node-id
get
Service SDWAN
Branch Mesh
Retrieve branch-devices by device serial number
get
Create/Update branch-devices by device serial number
put
Create branch-devices by device serial number
post
Delete branch-devices by device serial number
delete
Retrieve all branch-devices for given branch-mesh label
get
Retrieve branch-mesh config for given label
get
Create/Update branch-mesh config for given label
put
Create branch-mesh config for given label
post
Delete branch-mesh config for given label
delete
Retrieve branch-mesh by label
get
Retrieve branch-mesh config for all labels
get
Hub Configuration
Retrieve transit
get
Create/Update transit
put
Create transit
post
Delete transit
delete
Retrieve DC aggregate routes by prefix for given network segment
get
Create/Update DC aggregate routes by prefix for given network segment
put
Create DC aggregate routes by prefix for given network segment
post
Delete DC aggregate routes by prefix for given network segment
delete
Retrieve all DC aggregate route prefixes for given network segment
get
Retrieve DC aggregate routes for given network segment
get
Create/Update DC aggregate routes for given network segment
put
Create DC aggregate routes for given network segment
post
Delete DC aggregate routes for given network segment
delete
Retrieve DC aggregate routes for all network segments
get
Retrieve global hub configuration
get
Delete global hub configuration
delete
DC Preference
Retrieve hubs by device serial number
get
Delete hubs by device serial number
delete
Retrieve all hub devices for given branch group
get
Retrieve hub-clusters by cluster name and cluster group
get
Create/Update hub-clusters by cluster name and cluster group
put
Create hub-clusters by cluster name and cluster group
post
Delete hub-clusters by cluster name and cluster group
delete
Retrieve all hubs-clusters for given branch group
get
Retrieve branch/micro-branch configuration
get
Create/Update branch/micro-branch configuration
put
Create branch/micro-branch configuration
post
Delete branch/micro-branch configuration
delete
Microbranch Data-Center
Retrieve hub-clusters by identifier cluster-name cluster-group
get
Create/Update hub-clusters by identifier cluster-name cluster-group
put
Create hub-clusters by identifier cluster-name cluster-group
post
Delete hub-clusters by identifier cluster-name cluster-group
delete
Retrieve hub-clusters
get
Retrieve microbranch-dc-cluster
get
Create/Update microbranch-dc-cluster
put
Create microbranch-dc-cluster
post
Delete microbranch-dc-cluster
delete
Global Settings
Retrieve admin-status
get
Create/Update admin-status
put
Create admin-status
post
Delete admin-status
delete
Retrieve topology
get
Create/Update topology
put
Create topology
post
Delete topology
delete
Retrieve sdwan-global
get
Delete sdwan-global
delete
Network Segments
Retrieve network-segment-policy by segment name
get
Create/Update network-segment-policy by segment name
put
Create network-segment-policy by segment name
post
Delete network-segment-policy by segment name
delete
Retrieve network-segment-policy config for all segments
get
Route Policy
Retrieve as-number
get
Create/Update as-number
put
Create as-number
post
Delete as-number
delete
Retrieve timer
get
Create/Update timer
put
Create timer
post
Delete timer
delete
Retrieve global graceful restart timer configuration
get
Create/Update global graceful restart timer configuration
put
Create global graceful restart timer configuration
post
Delete global graceful restart timer configuration
delete
Retrieve best-path-computation
get
Create/Update best-path-computation
put
Create best-path-computation
post
Delete best-path-computation
delete
Retrieve global hub route policy configuration
get
Create/Update global hub route policy configuration
put
Create global hub route policy configuration
post
Delete global hub route policy configuration
delete
Retrieve global load-balance orchestration configuration
get
Create/Update global load-balance orchestration configuration
put
Create global load-balance orchestration configuration
post
Delete global load-balance orchestration configuration
delete
Retrieve route-policy
get
Delete route-policy
delete
Branch Aggregates
Retrieve global branch aggregate routes by prefix for given network segment
get
Create/Update global branch aggregate routes by prefix for given network segment
put
Create global branch aggregate routes by prefix for given network segment
post
Delete global branch aggregate routes by prefix for given network segment
delete
Retrieve all branch-aggregate prefixes for given segment
get
Retrieve global branch aggregate routes for given network segment
get
Create/Update global branch aggregate routes for given network segment
put
Create global branch aggregate routes for given network segment
post
Delete global branch aggregate routes for given network segment
delete
Retrieve branch-aggregate prefixes for all segments
get
Tunnel Policy
Retrieve rekey-interval
get
Create/Update rekey-interval
put
Create rekey-interval
post
Delete rekey-interval
delete
Retrieve tunnel-policy
get
Create/Update tunnel-policy
put
Create tunnel-policy
post
Delete tunnel-policy
delete
Hub Mesh
Retrieve hub-groups by name
get
Create/Update hub-groups by name
put
Create hub-groups by name
post
Delete hub-groups by name
delete
Retrieve all hub-groups for given hub-mesh label
get
Retrieve hub-mesh by label
get
Create/Update hub-mesh by label
put
Create hub-mesh by label
post
Delete hub-mesh by label
delete
Retrieve hub-mesh config for all labels
get
Retrieve mesh-policy
get
Delete mesh-policy
delete
Group Configuration
Retrieve SDWAN global/group configuration
get
Delete SDWAN global/group configuration
delete
aruba_sdwan
Retrieve node_list by identifier node-type node-id
get
Service UCC
Aruba ucc
Retrieve DSCP Priority configuration for 'Skype for Business'
get
Create/Update DSCP Priority configuration for 'Skype for Business'
put
Create DSCP Priority configuration for 'Skype for Business'
post
Delete DSCP Priority configuration for 'Skype for Business'
delete
Retrieve 'dns_patterns' config for given dns_pattern
get
Create/Update 'dns_patterns' config for given dns_pattern
put
Create 'dns_patterns' config for given dns_pattern
post
Delete 'dns_patterns' config for given dns_pattern
delete
Retrieve all configured DNS patterns
get
Retrieve DSCP Priority configuration for Wifi Calling
get
Create/Update DSCP Priority configuration for Wifi Calling
put
Create DSCP Priority configuration for Wifi Calling
post
Delete DSCP Priority configuration for Wifi Calling
delete
Retrieve DSCP Priority configuration for SIP ALG
get
Create/Update DSCP Priority configuration for SIP ALG
put
Create DSCP Priority configuration for SIP ALG
post
Delete DSCP Priority configuration for SIP ALG
delete
Retrieve DSCP Priority configuration for MS Teams
get
Create/Update DSCP Priority configuration for MS Teams
put
Create DSCP Priority configuration for MS Teams
post
Delete DSCP Priority configuration for MS Teams
delete
Retrieve DSCP Priority configuration for Zoom
get
Create/Update DSCP Priority configuration for Zoom
put
Create DSCP Priority configuration for Zoom
post
Delete DSCP Priority configuration for Zoom
delete
Retrieve ucc_alg
get
Create/Update ucc_alg
put
Create ucc_alg
post
Delete ucc_alg
delete
Retrieve activate
get
Create/Update activate
put
Create activate
post
Delete activate
delete
Retrieve UCC settings
get
Create/Update UCC settings
put
Create UCC settings
post
Delete UCC settings
delete
Retrieve complete UCC config
get
Create/Update complete UCC config
put
Create complete UCC config
post
Delete complete UCC config
delete
Retrieve node_list by identifier node-type node-id
get
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 Commands
get
List Troubleshooting CX Commands
get
Get Troubleshooting Output
get
Start Troubleshooting Session
post
Clear Troubleshooting Session
delete
Start Troubleshooting Session For CX Device
post
Get Troubleshooting Session ID
get
Get list of backups associated with the device serial with the given prefix
get
Initiate Running Config Backup For A Single Device
post
Initiate Running Config Backup For All Devices In A Group
post
Get list of backups associated with the device serial
get
Fetch the backup stored against the given name
get
Action Command
Action command for enroll est certificate
post
User Management
Users
List user accounts
get
Create a user account
post
Get user account details specified by user id
get
Delete user account details specified by user id
delete
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
Change user password
post
Reset user password
post
Bulk Users
Create multiple users account. The max no of accounts that can be created at once is 10.
post
Delete multiple users account. The max no of accounts that can be deleted at once is 10.
delete
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
Get task status
get
Roles
Get list of all roles
get
Get Role details
get
Delete a role
delete
Update a role
patch
Create a role in an app
post
Vgw
Get Cloud Accounts
Configure Cloud account for provider AWS
get
Configure Cloud account for provider Azure
get
Configure Cloud account for provider Zscaler
get
Create Cloud Account
Create Cloud Account for Provider (AWS/Azure/Zscaler)
post
Edit Cloud Account
Edit Cloud Account for Provider (Azure/Zscaler)
post
Delete Cloud Account
Delete cloud account for by account-id
delete
VisualRF
GeoFence
Get status of geofence
get
Enable geofence
post
Disable geofence
delete
Client Location
Get location of a specific client
get
Get a specific floor and location of all its clients
get
Rogue Location
Get location of a specific rogue access point
get
Get a specific floor and location of all its rogue access points
get
Floorplan
Get list of all campuses
get
Get a specific campus and its buildings
get
Get a specific building and its floors
get
Get details of a specific floor
get
Get background image of a specific floor
get
Get a specific floor and location of all its access points
get
Get location of a specific access point
get
Import
create floorplans using zip file (supported files are zip and .esx)
post
get last import operation information
get
Anonymization
Get status of anonymization
get
Enable anonymization
post
Disable anonymization
delete
Webhook
Webhooks
List webhooks
get
Add Webhook
post
Webhook setting for a specific item
get
Update webhook settings
put
Delete Webhooks
delete
Get Webhook Token
get
Refresh the webhook token
put
Test for webhook notification
get
Return a Gateway by cluster Id
get
https://{api-base-url}/v1/iot_gateways/
{id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://
api-base-url
/v1/iot_gateways/{id}
RESPONSE
Click
Try It!
to start a request and see the response here!
