Qodex.ai
Qodex.ai
Introduction
HPE Aruba Networking Central
Token Management-Create Token (Non SSO Users)
Step 1 - Login & Obtain CSRF TokenStep 3 - Acquire the Access TokenStep 2 - Obtain Authorization Code
Token Management-Refresh Token
Refresh Access Token
Token Management-Delete Token (Non SSO Users)
Delete Access Token
ACP Audit Trail-audit
Get details of an audit logGet all audit logs
ACP OFC Api Handler-Flowhandler
Check Status of Syslog App for given SerialIDs.Enable Syslog App on a list of given device SerialIDs.Enable/Disable the Syslog App.Check Status of Enabled Flow SerialID
AIOps-Wi-Fi Connectivity Dashboard
Wi-Fi Connectivity at GlobalWi-Fi Connectivity at GroupWi-Fi Connectivity at Site
AIOps-AI Insights List
List AI Insights for a NetworkList AI Insights for an APList AI Insights for a SwitchList AI Insights for a GatewayList AI Insights for a ClientList AI Insights for a Site
AIOps-AI Insight Details
AI Insight Details for a SwitchAI Insight Details for an APAI Insight Details for a NetworkAI Insight Details for a SiteAI Insight Details for a GatewayAI Insight Details for a Client
AirGroup-Summary
Get AirGroup Traffic Summary in terms of PacketsRetrieves device summary
AirGroup-Trend
Get temporal data about AirGroup based on the parameter passed
AirGroup-List
Retrieves a list of all hostnamesGet all the uncached services encountered by AirGroupRetrieves list of labels
AirGroup-Distribution
Retrieves a summary of all the services queried for.Retrieves a summary of the servers connected to AirGroup
AirGroup-Stats
Retrieves the suppression factor
AirMatch-AP
Returns all device (AP) running configuration for a customerChange a device running configChange a device running configGet number of AP's and AP modelsGet AP neighbor listReturns device (AP) running configurationGet AP info for all AP'sGet feasibility ap info of a specific AP ethernet MACGet AP info of a specific AP ethernet MACGet AP neighbor listReturns device (AP) running configurationReturns all device (AP) running configuration for a customer
AirMatch-Radio
Get all static radios for a customerGet information about radioGet history of a specific radio MACGet EIRP reasonsGet nbr pathloss of a neighbor MAC heard by a specific radio MACGet EIRP distributionGet neighbor stats informationGet RF events of a specific radio MACGet EIRP reasonsGet all nbr pathloss for a customer and radio MACGet all RF events of a tenant idGet all nbr pathloss for a customer and bandGet reporting radio of a specific radio MACGet radio neighbor listGet board limits of a specific radio MACGet all radar and noise RF events of a tenantGet radar and noise RF events of a specific radio MACGet all reporting radio for a customer
AirMatch-Solution
Get solution of a specific radio MACGet optimizations for tenantRun the algorithm for the solutionGet optimizations for tenant's requested partitionGet all solutions for a customer
AirMatch-Schedule
Get the jobs to be sent to deployer for AirMatch solution deploymentGet the list of unique timezone and deploy hours per tenantRMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour detailsGet the list of jobs generated by schedulerGet the schedule of all jobs computed by the schedulerRMQ message triggers a runnow job for a certain tenantTrigger - RMQ message with on-demand compute for a provided tenant id
AirMatch-Radio feasibility
Get all radio feasibility for a customerTrigger update of radio feasibilityGet all radio feasibility for a customerGet feasibility radio info of a specific radio MACGet radio_feasibility of a specific radio MACGet radio feasibility of a specific radio MAC
AirMatch-Deployer
Trigger test-config updateGet a list of pending deployments for a tenant idTrigger computation complete messageRMQ message generates southbound test action-msg
AirMatch-RF domain
Start partition processGet partition information
AirMatch-Telemetry
BootstrapPurge
AirMatch-Miscellaneous
Gets radios deployment statusReturns device (AP) running configurationReturns all device (AP) running configuration for all customers
AppRF-Overview
Gets Top N Apprf Statistics (V2 Version)(Deprecated) Gets Top N Apprf Statistics
AppRF-Applications
Gets Top N Applications
AppRF-Web Categories
Gets Top N Web categories
AppRF-App Categories
Gets Top N App categories
AppRF-Web Reputations
Gets Top Web Reputations
AppRF-AppRF IAP Meta Info
Gets Web Category id to name mappingGets Application id to name mappingGets Application Category id to name mappingGets Web Reputation id to name mapping
Audit Event Logs-audit
Get all audit events for all groupsGet details of an audit event/log
Authentication & Policy-Authentications and Sessions
Fetch list of authentications using Aruba Air Pass.Fetch list of authentications using Cloud Identity.Fetch details of a specific authentication using either Cloud Identity or Aruba Air Pass.Fetch list of sessions using Aruba Air Pass.Fetch list of sessions using Cloud Identity.
Authentication & Policy-Client Policy
Configure or update network access policy for registered clients.Delete existing Client Policy.Reset Client Policy.Fetch network access policy for registered clients.
Authentication & Policy-Client Registration
Fetch list of registered clients.Update registered client name.Delete registered client.Add registered client.
Authentication & Policy-Wi-Fi Easy Connect
Delete registered client.Update registered client with bootstrapping key.Fetch list of registered clients.Register a client.
Authentication & Policy-User Policy
Delete existing User Policy.Configure policy to allow wireless network access for users.Reset User Policy.Fetch policy that allows wireless network access for users.
Authentication & Policy-Download
Fetch all Mac Registrations as a CSV file.Fetch all Named MPSK as a CSV file.
Authentication & Policy-MPSK Networks Configs
Partially Edit a Named MPSK ConfigAdd a named MPSK configRead MPSK Usage StatsDelete an MPSK network configuration.Edit a Named MPSK ConfigRead all named MPSKRead a named MPSK configEdit an MPSK network configCreate an MPSK network configRead all configured MPSK networks.Delete a Named MPSK ConfigRead one MPSK network config.
Authentication & Policy-File Upload
Upload fileTerminate UploadRead upload status of last file uploadTerminate UploadUpload fileRead errors in last file uploadRead errors in last file uploadRead upload status of last file upload
Authentication & Policy-MAC Registration
Update registered client name.Add mac registration.Fetch list of mac registrations.Delete registered mac registration.
Authentication & Policy-User Management
Fetches certificate details of a userRevoke a user's device certificate
Ble Beacon Service-BleBeaconService
Edit ble beacon profileRetrieve ble beacon profilesRetrieve ble configured beaconsDelete one device beacon configRetrieve ble running beaconsUpdate one device beacon configDelete ble beacon profileConfig ble beacon profile
Client Match-Status
Get the status of Client Match Load Balancer for a tenantEnable or disable Client Match Band Steer to 6GHz for a particular tenant.Enable or disable Client Match Load Balancer for a particular tenant.Get the status of Client Match for a tenantEnable or disable Client Match for a particular tenant.Get the status of Client Match Band Steer to 6GHz for a tenant
Client Match-Unsteerable
Get the unsteerable state of a clientDelete the unsteerable state of a clientGet all unsteerable entries for a tenantSet the unsteerable state of a client
Cloud Connect-Cloud Connect
Creates a new Custom Cloud Account with name as account_nameUpdate Prisma cloud provider endpoint configGet config summary for configured groups.Trigger cloud provider endpoint scan.Delete Custom cloud provider endpoint configDelete AWS cloud provider endpoint configUpdate Zscaler cloud provider endpoint configDelete Tunnel Policy with name as policy_nameGet the Prisma Account Configuration for account_nameUpdates an existing Prisma Cloud Account with name as account_nameGet the list of all Tunnel Policy ConfigurationsDelete Azure cloud provider endpoint configUpdate Custom cloud provider endpoint configGet Zscaler node scan details.Update AWS cloud provider endpoint configGet all Cloud Provider endpoints.Create Custom cloud provider endpoint configDelete Prisma cloud provider endpoint configGet the Custom Cloud Account Configuration for account_nameGet configured vlan list for each cloud connect endpoint.Creates a new Prisma Cloud Account with name as account_nameCreate Prisma cloud provider endpoint configCreates a new Tunnel Policy with name as policy_nameGet the Tunnel Policy Configuration for policy_nameCreate Zscaler cloud provider endpoint configGet the list of valid Tunnel Policy configurationsUpdate Azure cloud provider endpoint configCreate AWS cloud provider endpoint configUpdates an existing Tunnel Policy with name as policy_nameDelete Zscaler cloud provider endpoint configCreate Azure cloud provider endpoint configDelete Prisma Cloud Account with name as account_nameDelete Custom Cloud Account with name as account_nameUpdates an existing Custom Cloud Account with name as account_name
Deprecated Device Inventory-Devices
Get status of refresh job(Deprecated) Get devices from device inventorySchedule a job to refresh the device inventoryGet devices statsAdd device using Mac and Serial numberVerify device additionGet devices from device inventory(Deprecated) Add device using Mac and Serial number(Deprecated) Get devices stats
Deprecated Device Inventory-Private Cloud Devices
Get device from device inventory
Deprecated Licensing-Subscriptions
MSP API:- Assign licenses to all the devices owned by tenant customers.(Deprecated) Get user subscription keysStandalone customer API:- Assign licenses to all devices.MSP API:- Remove service licenses to all the devices owned by tenants and MSP.(Deprecated) Assign subscription to a device(Deprecated) Get enabled services for customer(Deprecated) Get subscription statsStandalone customer API:- Un-assign licenses to all devices for given services.(Deprecated) Unassign subscription to a device(Deprecated) Get services licensing config
Deprecated Licensing-Auto-License
(Deprecated) MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.(Deprecated) Standalone Customer API:- Disable auto licensing for given services.(Deprecated) Get services and corresponding license token availability status.(Deprecated) Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.(Deprecated) Get auto enabled services for msp or tenant customer.(Deprecated) Get the services which are auto enabled.(Deprecated) MSP API:- Disable auto license settings at msp and its tenant level for given services.
Device Management-ActionCommand
Generic Action Command for bouncing interface or POE (power-over-ethernet) portGeneric commands for deviceGeneric Action Command for bouncing interface or POE (power-over-ethernet) portStatusSpeed TestGeneric commands for swarmDisconnect User
Device Management-DMS
Delete Mobility Master to Mobility Device mappingGet assigned Mobility Master to Mobility Device.Statically assign Mobility Master to Mobility Device.
Device Replacement-Offline Devices
Get all offline devices
Device Replacement-Request Replacement
To request device replacement
Device Replacement-Check Compliance
To check compliance
Device Replacement-Initiate Replacement
To initiate device replacement
Device Replacement-Cancel Replacement
To cancel device replacement
Device Replacement-Devices Under Replacement
To get devices under replacement
Device Replacement-Device status
To check device status
Device Replacement-Device count
To get device count for a Tenant/Standalone account
Device Replacement-MSP Replacement Count
Count of devices under replacement for a MSP customer
Device Replacement-Get MSP customers
Get all tenants under that MSP account
Device Replacement-MSP replacement details
Get replacement details of all tenants under that MSP account
Device Routing - BGP-Neighbor
List BGP neighbor InformationList of routes learned form a BGP neighborList of routes advertised to a BGP neighborGet BGP neighbor detailed informationReset/clear BGP neighbor session
Device Routing - BGP-Route
List BGP routes
Device Routing - OSPF-Area
List OSPF Area Information
Device Routing - OSPF-Interface
List OSPF Interface Information
Device Routing - OSPF-Neighbor
List OSPF neighbor Information
Device Routing - OSPF-LinkStateDatabase
List OSPF Link State Database Information
Device Routing - Overlay-Connection
Get information about overlay control connectionReset overlay control connection
Device Routing - Overlay-Interface
List of overlay interfaces (tunnels)
Device Routing - Overlay-RouteLearned
List of learned routes from overlay
Device Routing - Overlay-RouteLearnedBest
List of best learned routes from overlay
Device Routing - Overlay-RouteAdvertised
List of advertised routes to overlay
Device Routing - RIP-Interface
List RIP interfaces
Device Routing - RIP-Neighbor
List RIP neighborsList of routes learned from a RIP neighbor
Device Routing - RIP-Route
List RIP routes
Device Routing - RouteTable-Route
Get legacy routesGet routes
DPS Monitoring-DPS
DPS Compliance percentage of all DPS Policies for a given BOC.Gets DPS Policy stats for a given BOC.Gets DPS Compliance stats for a given Site.DPS Compliance Status of all DPS Policies for a given BOC.DPS Key Performance Indicator for a given BOC.Gets DPS Policy Event Logs for a given BOC.Gets DPS Policy stats for a given BOC.
Firmware-Firmware Management
Firmware UpgradeCancel Scheduled Upgrade at Customer LevelList Firmware Details of SwarmsClear Firmware Compliance Version for TenantSet Firmware Compliance VersionFirmware Upgrade at MSP LevelSet Firmware Compliance Version for MSP customerList Firmware VersionCancel Scheduled UpgradeSet Firmware Compliance Version for TenantFirmware Details of SwarmClear Firmware Compliance VersionFirmware Details of DeviceFirmware StatusList Model FamilySet Firmware Compliance Version CustomerGet Firmware Compliance Version for MSP CustomerGet Firmware Compliance Version for TenantGet Firmware Compliance VersionCancel Scheduled Upgrade at MSP LevelFirmware VersionList Firmware Details of a TenantClear Firmware Compliance Version for MSP CustomerList Firmware Details of DevicesFirmware Upgrade at Customer LevelCancel Scheduled Upgrade at MSP LevelCancel Scheduled Upgrade at Customer Level
GDPR-GDPR
Delete Opt out MacGDPR Opt out MACAdd Gdpr opt out clientList gdprs opt out MAC clients for this customer
Guest-Portals
Create a new guest portal profileGet guest portal profileUpdate guest portal profileGet all portals with limited dataGet preview url of guest portal profileDelete guest portal profile
Guest-Sessions
Get all sessions of a ssid
Guest-Visitors
Delete guest visitor accountGet all visitors created against a portalGet guest visitor accountCreate a new guest visitor of a portalUpdate guest visitor account
Guest-Wlans
Get all guest wlans
Guest-Troubleshoot
Check if guest is enabled for current user.Provision cloud guest for current customer
Guest-WiFi4EU
WiFi4EU Status
Guest-Summary
Get summary statistics
Install Manager-Installer
Delete an installerInvite a new installerUpdate an installerGet all installers
Install Manager-QR code
Get QR code listCreate a QR codeDelete a QR codeUpdate a QR code
Install Manager-Sites
Get all assigned group to sites listUpdate site statusFor a given set of site names, assign Group Names for each device type
IoT - App Developer Portal-Apps
Get App Version DetailsCreate AppList App VersionsDelete App VersionEdit Draft AppWithdraw App VersionList Draft AppsList Published and Suspended AppsValidate App NameSubmit App
IoT - App Developer Portal-Container Image
List ImagesList Images For Max VersionValidate Image NameUpload Image
IoT - Appstore-App Store
Upgrade appEdit Developer installed app configurationSearch appsDeveloper infoUpgrade developer appInstall appGet App IconFind Recommended AppsEdit Installed app configurationCount all installed appsGet Developer AppInstall Developer appDelete Developer appGet the last 10 versions of an AppDeveloper appsFind all installed appsGet Developer App IconGet AppDelete app
IoT - Device-Devices
Return the count of devices by Device ClassReturn the count of devices with one or more device classesReturn a time-series device count by collectorIdReturn the count of devicesReturn Pageable List of all devicesReturn the count of devices reporters by CollectorReturn Pageable List of all devicesReturn a device by IdReturn Pageable List of AttributesReturn the count of devices by typeReturn the time-series from device
IoT - Iotgateway-association
Return Pageable List of GatewaysReturn Pageable List of GatewaysAdd AssociationDelete AssociationReturns security token associated with a collector
IoT - Iotgateway-groups
Group moveGroup moveReturns connector to group mapping
IoT - Iotgateway-iot_gateways
Return Pageable List of GatewaysReturn Pageable List of GatewaysReturn a Gateway by cluster Id
IoT - Transport Profile-Transport Profile
Get a list of all device classesUpdate a transport profile by idGet a transport profile by idCount transport profilesCreate a transport profileFind transport profilesDelete a transport profile by id
Monitoring-AP
Top N AP DetailsAP RF SummaryList Access PointsDelete APList BSSIDsAP Bandwidth UsageAP Details
Monitoring-Network
WLAN Network Bandwidth usageGet Network detailsList all Networks
Monitoring-Client
Wireless Client Mobility TrailConnected Wired Client DetailsConnected Wireless Client DetailsClient DetailsClient Bandwidth UsageList Unified Clients (Wired/Wireless). Option to choose Connected/Failed ClientsList Connected Wired ClientsList Connected Wireless ClientsTop N ClientsTotal Clients Count
Monitoring-Swarm
Top N Swarms By Bandwidth UsageList SwarmsSwarm DetailsTop N Swarms By Clients Count
Monitoring-Label
Unassociate Label from deviceCreate LabelList Default LabelsUnassociate a label from a list of devicesAssociate Label to a list of devicesUpdate LabelLabel detailsAssociate Label to deviceList LabelsDelete LabelList Label Categories
Monitoring-Site
Unassociate a site from a list of devicesUpdate SiteCreate SiteAssociate Site to deviceUnassociate Site from deviceList SitesAssociate Site to a list of devicesSite detailsDelete Site
Monitoring-Switch
Switch Chassis DetailsGet vlan info of the switchSwitch Stack DetailsGet switch poe info for CX switchGet switch vsx info for CX switchPorts Bandwidth Usage for CX SwitchDelete SwitchList SwitchesSwitch Ports DetailsTop N SwitchesGet switch poe infoCX Switch Stack Port DetailsGet vlan info of the switch stackSwitch Bandwidth UsageSwitch Stack Port DetailsGet lldp device neighbor info for CX switch stackDelete Switch StackGet vlan info for CX switchList Switch StacksSwitch DetailsGet vlan info of the CX switch stackSwitch Ports Bandwidth UsageSwitch Ports ErrorsGet switch port poe infoGet switch port poe info for CX switchCX Switch Ports ErrorsGet lldp device neighbor info for CX switchGet ports details for CX switch
Monitoring-Events
(Deprecated) List EventsList Events
Monitoring-VPN
Swarm VPN statsVpn Details
Monitoring-MobilityController
Delete Mobility ControllerList Mobility ControllersMobility Controllers Ports Bandwidth UsageDelete Mobility ControllerMobility Controllers Ports DetailsMobility Controller DetailsMobility Controller DetailsMobility Controllers VLAN detailsList Mobility Controllers
Monitoring-Gateway
Gateway Ports DetailsDelete GatewayGateway Uplink WAN compression statsGateway DHCP Pools detailsGateway Uplink tunnel statsGateway Port ErrorsGateway VLAN detailsGateway Tunnels DetailsGateway Uplink Bandwidth UsageGateway Ports Bandwidth UsageGateway DetailsGateway Uplink distributionGateway Uplink DetailsGateway DHCP Clients informationGateway List
MSP-Customers
(Deprecated) Update a customerDelete a customerGet details of customer(Deprecated) Create a new customerGet list of customers under the MSP account based on limit and offsetUpdate a customerCreate a new customer
MSP-Devices
Get list of devices and licenses under the MSP account based on limit and offset, offset should be a multiple of the limit valueUn-assign all devices from Tenant/end-customer.Move a device to an end-customerGet list of devices and licenses under the Customer account based on limit and offset, offset should be a multiple of the limit value
MSP-Resources
Get the resource under the MSPEdit an existing resource for the MSP
MSP-Users
Get list of users under the MSP account based on limit and offsetGet list of users under the Customer account based on limit and offset
MSP-Groups
Get list of customers mapped to MSP group based on limit and offset.
MSP-Get Country Code
Get list of country code
Network Health-Network Health
Get data for all sites
New Device Inventory-Devices
(Deprecated) Schedule a job to refresh the device inventory(Deprecated) Get status of refresh jobGet Archived devices from device inventoryArchive devices using Serial listDelete devices using Serial numberGet devices statsAdd device using Mac and Serial numberUnarchive devices using Serial listGet devices from device inventoryVerify device addition
New Device Inventory-Private Cloud Devices
Get device from device inventory
New Device Inventory-MSP Devices
assign the device to the end-customerA filterable paginated response of a list of devices and licenses under the MSP account based on the provided limit and offset parameters.A filterable paginated response of a list of devices and licenses under the customer account based on the provided limit and offset parameters
New Licensing-Subscriptions
Unassign subscription to a deviceGet subscription statsStandalone customer API:- Assign licenses to all devices.MSP API:- Assign licenses to all the devices owned by tenant customers.Get user subscription keysStandalone customer API:- Un-assign licenses to all devices for given services.Assign subscription to a deviceGet services licensing configMSP API:- Remove service licenses to all the devices owned by tenants and MSP.Get enabled services for customer
New Licensing-Auto-License
Get the services which are auto enabled.Get services and corresponding license token availability status.MSP API:- Disable auto license settings at msp and its tenant level for given services.Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.Standalone Customer API:- Disable auto licensing for given services.Get auto enabled services for msp or tenant customer.
Notification-Notification
List NotificationsAcknowledge Notifications by ID List / AllAcknowledge NotificationGet notifications count by severity
Notification-Types
List Types
Notification-Settings
Get Customer account level SettingsUpdate settings detailsAdd settingsDelete SettingsUpdate customer settingsList Settings
Presence Analytics-Config
it retrieves RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.It retrieves visitor RSSI threshold, passerby RSSI threshold, dwell time threshold, access points and site name for site level configuration.It configures RSSI threshold, dwelltime threshold for visitor & RSSI threshold for passerby.it configure RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.It retrieves RSSI threshold for passerby conversion, RSSI threshold for visitor conversion & dwelltime threshold for passerby to visitor conversion.
Presence Analytics-Associated
Get details of connected and non connected visitors.
Presence Analytics-Loyalty
Get Bottom 5 sites Loyalty trends.Get loyalty aggregate values for list of sitesGet loyalty visits of visitors in histogramGet loyalty indicator trendsGet Bottom 5 sites Loyalty indicator aggregate values.Get Top 5 sites Loyalty indicator aggregate values.Get Top 5 sites Loyalty trends.Get loyalty indicator aggregate valuesGet presence analytics trends.Get loyalty visitors frequency.
Presence Analytics-PresenceStats
Get presence analytics trends.Get presence analytics trendsGet presence analytics metrics aggregate values
Presence Analytics-License
Enable or disable PA license.List of devices per site with their pa license status.Customer level device license status.
Presence Analytics-Insights
Get presence aggregate values for list of sitesGet Bottom 5 sites aggregate values.Get Top 5 sites aggregate values.Get presence aggregate values for list of sites.
RAPIDS-Rogues
List suspect APsList manually contained APsList Interfering APsList neighbor APsList Rogue APs
RAPIDS-WIDS
List Infrastructure AttacksList Client AttacksWIDS Events
Reporting-Reports
Generated ReportsScheduled ReportsGenerated ReportsScheduled Reports
Reporting-SDWAN Reports
SDWAN DPS policy compliance report
Service Airgroup-Aruba airgroup
Retrieve complete visibility ap_list for given serverDelete complete Airgroup config for given Global or GroupRetrieve all airgroup service policies at given Global or groupCreate allowed vlan for given serviceCreate/Update airgroup server config by mac_addressCreate service-id mapping for given standard serviceDelete disallowed role for given serverDelete custom service for given nameCreate/Update Personal device visibility configurationRetrieve role restrictions for given airgroup serverCreate disallowed vlan for given serviceCreate/Update entry for serial_number in visibility ap_list for given serverDelete allowed role for given serviceCreate/Update allowed vlan for given serviceRetrieve all service-ids for given standard serviceRetrieve node_list by identifier node-type node-idDelete General settings for given Global or GroupDelete role restrictions for given airgroup serverDelete airgroup server config by mac_addressCreate entry for serial_number in visibility ap_list for given serverRetrieve airgroup server config by mac_addressRetrieve all disallowed vlans for given serviceDelete role restrictions for given service at global or groupRetrieve all allowed roles for given serverCreate/Update allowed role for given serviceCreate/Update entry in admin user-ids for given user_idDelete allowed role for given serverCreate/Update airgroup_statusCreate vlan restriction for given service at Global or groupCreate standard service for given nameCreate/Update role restrictions for given service at global or groupCreate/Update service-id for given custom serviceRetrieve complete Airgroup config for given Global or GroupDelete service-id for given custom serviceRetrieve all allowed vlans for given serviceCreate/Update disallowed role for given serverRetrieve entry in admin user-ids for given user_idRetrieve service-id for given custom serviceDelete network visibility config for given airgroup serverCreate/Update standard service for given nameRetrieve role restrictions for given service at global or groupCreate allowed role for given serviceCreate airgroup service policy by name at Global or groupDelete airgroup service policy by name at Global or groupCreate airgroup server config by mac_addressCreate/Update vlan restriction for given service at Global or groupCreate/Update disallowed vlan for given serviceRetrieve airgroup service policy by name at Global or groupCreate/Update network visibility config for given airgroup serverCreate disallowed role for given serviceCreate custom service for given nameCreate General settings for given Global or GroupCreate airgroup_statusRetrieve disallowed role for given serviceRetrieve service-id mapping for given standard serviceDelete vlan restriction for given service at Global or groupRetrieve allowed role for given serviceDelete allowed vlan for given serviceRetrieve vlan restriction for given service at Global or groupRetrieve disallowed role for given serverRetrieve all disallowed roles for given serverRetrieve all standard Airgroup service definitionsRetrieve all user-ids treated as admin users for device visibilityRetrieve Personal device visibility configurationRetrieve allowed vlan for given serviceRetrieve General settings for given Global or GroupRetrieve allowed role for given serverCreate disallowed role for given serverRetrieve disallowed vlan for given serviceRetrieve common_configCreate role restrictions for given airgroup serverRetrieve all allowed roles for given serviceCreate/Update role restrictions for given airgroup serverDelete entry for serial_number in visibility ap_list for given serverRetrieve entry for serial_number in visibility ap_list for given serverDelete disallowed role for given serviceCreate service-id for given custom serviceRetrieve all disallowed roles for given serviceCreate/Update General settings for given Global or GroupCreate/Update service-id mapping for given standard serviceDelete entry in admin user-ids for given user_idRetrieve all custom service definitionsCreate/Update disallowed role for given serviceCreate/Update allowed role for given serverRetrieve all service-ids in given custom serviceRetrieve network visibility config for given airgroup serverDelete disallowed vlan for given serviceRetrieve standard service for given nameCreate allowed role for given serverRetrieve airgroup_statusRetrieve custom service for given nameDelete airgroup_statusCreate role restrictions for given service at global or groupCreate/Update airgroup service policy by name at Global or groupCreate entry in admin user-ids for given user_idCreate network visibility config for given airgroup serverDelete Personal device visibility configurationCreate/Update custom service for given nameCreate Personal device visibility configurationRetrieve all configured airgroup servers
Service Airmatch-Aruba airmatch
Delete systemCreate configRetrieve node_list by identifier node-type node-idCreate/Update configCreate/Update systemCreate systemDelete configRetrieve systemRetrieve config
Service IDS IPS-Aruba ids ips
Create complete config for IDS/IPSCreate/Update SIEM server notification configurationDelete SIEM server notification configurationDelete complete config for IDS/IPSCreate/Update SIEM server config for given siem_server_nameRetrieve SIEM server config for given siem_server_nameDelete SIEM server config for given siem_server_nameRetrieve complete config for IDS/IPSCreate SIEM server notification configurationRetrieve SIEM server notification configurationCreate/Update complete config for IDS/IPSRetrieve node_list by identifier node-type node-idRetrieve config for all SIEM serversCreate SIEM server config for given siem_server_name
Service IPMS-Aruba ipms
Create IP address pool for given pool_nameRetrieve node_list by identifier node-type node-idCreate/Update IP range by range_id for given address pool_nameRetrieve all IP ranges for given address pool_nameCreate/Update IP address pool for given pool_nameCreate IP range by range_id for given address pool_nameRetrieve all IP address poolsRetrieve IP range by range_id for given address pool_nameRetrieve complete IPMS configDelete IP address pool for given pool_nameRetrieve IP address pool for given pool_name
Service Overlay Wlan-Aruba overlay wlan
Delete Cluster mapping for given profile and profile_typeRetrieve all Profile to Cluster mappings for given groupDelete Complete Overlay-wlan config for given groupRetrieve Complete Overlay-wlan config for given groupDelete Cluster mapping by redundancy-type and group-name for given profile and typeCreate/Update Cluster mapping by redundancy-type and group-name for given profile and typeCreate Complete Overlay-wlan config for given groupCreate/Update Complete Overlay-wlan config for given groupRetrieve Cluster mapping for given profile and profile_typeCreate Cluster mapping by redundancy-type and group-name for given profile and typeRetrieve all Cluster mappings for given profile and typeCreate/Update Cluster mapping for given profile and profile_typeRetrieve node_list by identifier node-type node-idCreate Cluster mapping for given profile and profile_typeRetrieve Cluster mapping by redundancy-type and group-name for given profile and type
Service RAPIDS-Aruba Rapids
Retrieve essid in include SSIDs for given classification rule_nameCreate/Update essid in include SSIDs for given classification rule_nameCreate essid in include SSIDs for given classification rule_nameDelete essid in include SSIDs for given classification rule_nameRetrieve all include SSIDs for given classification rule_nameRetrieve essid in exclude SSIDs for given classification rule_nameCreate/Update essid in exclude SSIDs for given classification rule_nameCreate essid in exclude SSIDs for given classification rule_nameDelete essid in exclude SSIDs for given classification rule_nameRetrieve all exclude SSIDs for given classification rule_nameRetrieve site by name in Site-Includes for given classification rule_nameCreate/Update site by name in Site-Includes for given classification rule_nameCreate site by name in Site-Includes for given classification rule_nameDelete site by name in Site-Includes for given classification rule_nameRetrieve all sites in Site-Includes for given classification rule_nameRetrieve site by name in Site-Excludes for given classification rule_nameCreate/Update site by name in Site-Excludes for given classification rule_nameCreate site by name in Site-Excludes for given classification rule_nameDelete site by name in Site-Excludes for given classification rule_nameRetrieve all sites in Site-Excludes for given classification rule_nameRetrieve match criteria for given classification rule_nameCreate/Update match criteria for given classification rule_nameCreate match criteria for given classification rule_nameDelete match criteria for given classification rule_nameRetrieve Classification rule by ruel_nameCreate/Update Classification rule by ruel_nameCreate Classification rule by ruel_nameDelete Classification rule by ruel_nameRetrieve all Classification rulesRetrieve complete RAPIDS configurationCreate/Update complete RAPIDS configurationCreate complete RAPIDS configurationDelete complete RAPIDS configurationRetrieve node_list by identifier node-type node-id
Service SDWAN-Branch Mesh
Create/Update branch-mesh config for given labelRetrieve all branch-devices for given branch-mesh labelCreate branch-mesh config for given labelRetrieve branch-mesh by labelRetrieve branch-devices by device serial numberRetrieve branch-mesh config for given labelDelete branch-devices by device serial numberDelete branch-mesh config for given labelCreate branch-devices by device serial numberCreate/Update branch-devices by device serial numberRetrieve branch-mesh config for all labels
Service SDWAN-Hub Configuration
Delete global hub configurationRetrieve DC aggregate routes for given network segmentCreate DC aggregate routes for given network segmentCreate transitRetrieve all DC aggregate route prefixes for given network segmentDelete transitCreate/Update DC aggregate routes for given network segmentDelete DC aggregate routes for given network segmentRetrieve transitRetrieve DC aggregate routes for all network segmentsCreate DC aggregate routes by prefix for given network segmentCreate/Update transitDelete DC aggregate routes by prefix for given network segmentCreate/Update DC aggregate routes by prefix for given network segmentRetrieve global hub configurationRetrieve DC aggregate routes by prefix for given network segment
Service SDWAN-DC Preference
Retrieve all hubs-clusters for given branch groupRetrieve hub-clusters by cluster name and cluster groupRetrieve hubs by device serial numberDelete hub-clusters by cluster name and cluster groupCreate/Update branch/micro-branch configurationCreate hub-clusters by cluster name and cluster groupDelete branch/micro-branch configurationRetrieve all hub devices for given branch groupDelete hubs by device serial numberRetrieve branch/micro-branch configurationCreate branch/micro-branch configurationCreate/Update hub-clusters by cluster name and cluster group
Service SDWAN-Microbranch Data-Center
Create/Update microbranch-dc-clusterRetrieve hub-clusters by identifier cluster-name cluster-groupCreate hub-clusters by identifier cluster-name cluster-groupCreate/Update hub-clusters by identifier cluster-name cluster-groupDelete hub-clusters by identifier cluster-name cluster-groupRetrieve hub-clustersDelete microbranch-dc-clusterRetrieve microbranch-dc-clusterCreate microbranch-dc-cluster
Service SDWAN-Global Settings
Delete admin-statusCreate/Update topologyDelete topologyRetrieve topologyCreate topologyRetrieve admin-statusRetrieve sdwan-globalCreate/Update admin-statusDelete sdwan-globalCreate admin-status
Service SDWAN-Network Segments
Create network-segment-policy by segment nameDelete network-segment-policy by segment nameRetrieve network-segment-policy by segment nameCreate/Update network-segment-policy by segment nameRetrieve network-segment-policy config for all segments
Service SDWAN-Route Policy
Retrieve global load-balance orchestration configurationCreate best-path-computationCreate/Update best-path-computationRetrieve as-numberCreate/Update as-numberRetrieve global hub route policy configurationCreate timerDelete global graceful restart timer configurationCreate/Update global load-balance orchestration configurationDelete best-path-computationRetrieve global graceful restart timer configurationCreate global graceful restart timer configurationRetrieve best-path-computationCreate/Update global hub route policy configurationCreate/Update global graceful restart timer configurationDelete timerDelete route-policyDelete global load-balance orchestration configurationDelete as-numberRetrieve route-policyCreate/Update timerCreate global hub route policy configurationCreate as-numberDelete global hub route policy configurationCreate global load-balance orchestration configurationRetrieve timer
Service SDWAN-Branch Aggregates
Create/Update global branch aggregate routes for given network segmentCreate global branch aggregate routes for given network segmentDelete global branch aggregate routes for given network segmentCreate global branch aggregate routes by prefix for given network segmentDelete global branch aggregate routes by prefix for given network segmentRetrieve global branch aggregate routes by prefix for given network segmentRetrieve all branch-aggregate prefixes for given segmentRetrieve branch-aggregate prefixes for all segmentsCreate/Update global branch aggregate routes by prefix for given network segmentRetrieve global branch aggregate routes for given network segment
Service SDWAN-Tunnel Policy
Retrieve tunnel-policyDelete rekey-intervalCreate rekey-intervalCreate tunnel-policyCreate/Update rekey-intervalRetrieve rekey-intervalDelete tunnel-policyCreate/Update tunnel-policy
Service SDWAN-Hub Mesh
Retrieve hub-mesh by labelRetrieve all hub-groups for given hub-mesh labelCreate/Update hub-groups by nameDelete mesh-policyRetrieve hub-mesh config for all labelsCreate hub-mesh by labelCreate hub-groups by nameCreate/Update hub-mesh by labelRetrieve mesh-policyDelete hub-groups by nameDelete hub-mesh by labelRetrieve hub-groups by name
Service SDWAN-Group Configuration
Retrieve SDWAN global/group configurationDelete SDWAN global/group configuration
Service SDWAN-aruba_sdwan
Retrieve node_list by identifier node-type node-id
Service UCC-Aruba ucc
Retrieve DSCP Priority configuration for 'Skype for Business'Create/Update DSCP Priority configuration for 'Skype for Business'Create DSCP Priority configuration for 'Skype for Business'Delete DSCP Priority configuration for 'Skype for Business'Retrieve 'dns_patterns' config for given dns_patternCreate/Update 'dns_patterns' config for given dns_patternCreate 'dns_patterns' config for given dns_patternDelete 'dns_patterns' config for given dns_patternRetrieve all configured DNS patternsRetrieve DSCP Priority configuration for Wifi CallingCreate/Update DSCP Priority configuration for Wifi CallingCreate DSCP Priority configuration for Wifi CallingDelete DSCP Priority configuration for Wifi CallingRetrieve DSCP Priority configuration for SIP ALGCreate/Update DSCP Priority configuration for SIP ALGCreate DSCP Priority configuration for SIP ALGDelete DSCP Priority configuration for SIP ALGRetrieve DSCP Priority configuration for MS TeamsCreate/Update DSCP Priority configuration for MS TeamsCreate DSCP Priority configuration for MS TeamsDelete DSCP Priority configuration for MS TeamsRetrieve ucc_algCreate/Update ucc_algCreate ucc_algDelete ucc_algRetrieve activateCreate/Update activateCreate activateDelete activateRetrieve UCC settingsCreate/Update UCC settingsCreate UCC settingsDelete UCC settingsRetrieve complete UCC configCreate/Update complete UCC configCreate complete UCC configDelete complete UCC configRetrieve node_list by identifier node-type node-idCreate/Update DSCP Priority configuration for ZoomDelete DSCP Priority configuration for ZoomRetrieve DSCP Priority configuration for ZoomCreate DSCP Priority configuration for Zoom
SSO Configuration-SSO Support
Un-claim domainUpdate IDP configurationExtract Saml metadata from fileGet saml metadataAdd IDP configGet domain list
Topology-Topology
Get details of an uplink.Get neighbor details reported by AP via LLDP.Get list of unreachable devices in a site.Get details of an edge.Get details of an edge for the selected source and destination.Get details of a device.Get topology details of a site.Get vlan list of a site.Get tunnel details.
Troubleshooting-Troubleshooting
List Troubleshooting CommandsClear Troubleshooting SessionStart Troubleshooting SessionInitiate Running Config Backup For A Single DeviceInitiate Running Config Backup For All Devices In A GroupStart Troubleshooting Session For CX DeviceList Troubleshooting CX CommandsGet Troubleshooting OutputGet Troubleshooting Session IDGet list of backups associated with the device serialGet list of backups associated with the device serial with the given prefixFetch the backup stored against the given name
Troubleshooting-Action Command
Action command for enroll est certificate
UnifiedCommunications-Summary
Fetch Summary
UnifiedCommunications-UC Clients
Fetch number of Clients
UnifiedCommunications-Session counts by session type
Fetch session counts based on session type
UnifiedCommunications-Session counts by alg
Fetch session counts based on alg name
UnifiedCommunications-Session quality by Session type
Fetch session quality based on session type
UnifiedCommunications-Session quality by SSID
Fetch session quality based on ssid
UnifiedCommunications-Insights count
Fetch number of insights for a day
UnifiedCommunications-Insights
Fetch insights for a day. start time 00:00:00 and end time 23:59:59
UnifiedCommunications-CDR
Fetch list of CDRsExport list of CDRs
UnifiedCommunications-SkypeCentralURL
Fetch skype server central termination URL
User Management-Users
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 eReset user passwordDelete user account details specified by user idCreate a user accountGet user account details specified by user idList user accountsChange user password
User Management-Bulk Users
Get task statusCreate multiple users account. The max no of accounts that can be created at once is 10.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 accountDelete multiple users account. The max no of accounts that can be deleted at once is 10.
User Management-Roles
Get Role detailsUpdate a roleGet list of all rolesCreate a role in an appDelete a role
Vgw-Get Cloud Accounts
Configure Cloud account for provider AzureConfigure Cloud account for provider AWSConfigure Cloud account for provider Zscaler
Vgw-Create Cloud Account
Create Cloud Account for Provider (AWS/Azure/Zscaler)
Vgw-Edit Cloud Account
Edit Cloud Account for Provider (Azure/Zscaler)
Vgw-Delete Cloud Account
Delete cloud account for by account-id
VisualRF-Client Location
Get a specific floor and location of all its clientsGet location of a specific client
VisualRF-Rogue Location
Get a specific floor and location of all its rogue access pointsGet location of a specific rogue access point
VisualRF-Floorplan
Get list of all campusesGet details of a specific floorGet a specific floor and location of all its access points Get a specific campus and its buildingsGet location of a specific access pointGet a specific building and its floorsGet background image of a specific floor
VisualRF-Import
get last import operation informationcreate floorplans using zip file (supported files are zip and .esx)
VisualRF-Anonymization
Disable anonymizationEnable anonymizationGet status of anonymization
VisualRF-GeoFence
Enable geofenceGet status of geofenceDisable geofence
Webhook-Webhooks
Add WebhookDelete WebhooksWebhook setting for a specific itemList webhooksUpdate webhook settingsRefresh the webhook tokenTest for webhook notificationGet Webhook Token
Introduction
HPE Aruba Networking Central
Token Management-Create Token (Non SSO Users)
Step 1 - Login & Obtain CSRF TokenStep 3 - Acquire the Access TokenStep 2 - Obtain Authorization Code
Token Management-Refresh Token
Refresh Access Token
Token Management-Delete Token (Non SSO Users)
Delete Access Token
ACP Audit Trail-audit
Get details of an audit logGet all audit logs
ACP OFC Api Handler-Flowhandler
Check Status of Syslog App for given SerialIDs.Enable Syslog App on a list of given device SerialIDs.Enable/Disable the Syslog App.Check Status of Enabled Flow SerialID
AIOps-Wi-Fi Connectivity Dashboard
Wi-Fi Connectivity at GlobalWi-Fi Connectivity at GroupWi-Fi Connectivity at Site
AIOps-AI Insights List
List AI Insights for a NetworkList AI Insights for an APList AI Insights for a SwitchList AI Insights for a GatewayList AI Insights for a ClientList AI Insights for a Site
AIOps-AI Insight Details
AI Insight Details for a SwitchAI Insight Details for an APAI Insight Details for a NetworkAI Insight Details for a SiteAI Insight Details for a GatewayAI Insight Details for a Client
AirGroup-Summary
Get AirGroup Traffic Summary in terms of PacketsRetrieves device summary
AirGroup-Trend
Get temporal data about AirGroup based on the parameter passed
AirGroup-List
Retrieves a list of all hostnamesGet all the uncached services encountered by AirGroupRetrieves list of labels
AirGroup-Distribution
Retrieves a summary of all the services queried for.Retrieves a summary of the servers connected to AirGroup
AirGroup-Stats
Retrieves the suppression factor
AirMatch-AP
Returns all device (AP) running configuration for a customerChange a device running configChange a device running configGet number of AP's and AP modelsGet AP neighbor listReturns device (AP) running configurationGet AP info for all AP'sGet feasibility ap info of a specific AP ethernet MACGet AP info of a specific AP ethernet MACGet AP neighbor listReturns device (AP) running configurationReturns all device (AP) running configuration for a customer
AirMatch-Radio
Get all static radios for a customerGet information about radioGet history of a specific radio MACGet EIRP reasonsGet nbr pathloss of a neighbor MAC heard by a specific radio MACGet EIRP distributionGet neighbor stats informationGet RF events of a specific radio MACGet EIRP reasonsGet all nbr pathloss for a customer and radio MACGet all RF events of a tenant idGet all nbr pathloss for a customer and bandGet reporting radio of a specific radio MACGet radio neighbor listGet board limits of a specific radio MACGet all radar and noise RF events of a tenantGet radar and noise RF events of a specific radio MACGet all reporting radio for a customer
AirMatch-Solution
Get solution of a specific radio MACGet optimizations for tenantRun the algorithm for the solutionGet optimizations for tenant's requested partitionGet all solutions for a customer
AirMatch-Schedule
Get the jobs to be sent to deployer for AirMatch solution deploymentGet the list of unique timezone and deploy hours per tenantRMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour detailsGet the list of jobs generated by schedulerGet the schedule of all jobs computed by the schedulerRMQ message triggers a runnow job for a certain tenantTrigger - RMQ message with on-demand compute for a provided tenant id
AirMatch-Radio feasibility
Get all radio feasibility for a customerTrigger update of radio feasibilityGet all radio feasibility for a customerGet feasibility radio info of a specific radio MACGet radio_feasibility of a specific radio MACGet radio feasibility of a specific radio MAC
AirMatch-Deployer
Trigger test-config updateGet a list of pending deployments for a tenant idTrigger computation complete messageRMQ message generates southbound test action-msg
AirMatch-RF domain
Start partition processGet partition information
AirMatch-Telemetry
BootstrapPurge
AirMatch-Miscellaneous
Gets radios deployment statusReturns device (AP) running configurationReturns all device (AP) running configuration for all customers
AppRF-Overview
Gets Top N Apprf Statistics (V2 Version)(Deprecated) Gets Top N Apprf Statistics
AppRF-Applications
Gets Top N Applications
AppRF-Web Categories
Gets Top N Web categories
AppRF-App Categories
Gets Top N App categories
AppRF-Web Reputations
Gets Top Web Reputations
AppRF-AppRF IAP Meta Info
Gets Web Category id to name mappingGets Application id to name mappingGets Application Category id to name mappingGets Web Reputation id to name mapping
Audit Event Logs-audit
Get all audit events for all groupsGet details of an audit event/log
Authentication & Policy-Authentications and Sessions
Fetch list of authentications using Aruba Air Pass.Fetch list of authentications using Cloud Identity.Fetch details of a specific authentication using either Cloud Identity or Aruba Air Pass.Fetch list of sessions using Aruba Air Pass.Fetch list of sessions using Cloud Identity.
Authentication & Policy-Client Policy
Configure or update network access policy for registered clients.Delete existing Client Policy.Reset Client Policy.Fetch network access policy for registered clients.
Authentication & Policy-Client Registration
Fetch list of registered clients.Update registered client name.Delete registered client.Add registered client.
Authentication & Policy-Wi-Fi Easy Connect
Delete registered client.Update registered client with bootstrapping key.Fetch list of registered clients.Register a client.
Authentication & Policy-User Policy
Delete existing User Policy.Configure policy to allow wireless network access for users.Reset User Policy.Fetch policy that allows wireless network access for users.
Authentication & Policy-Download
Fetch all Mac Registrations as a CSV file.Fetch all Named MPSK as a CSV file.
Authentication & Policy-MPSK Networks Configs
Partially Edit a Named MPSK ConfigAdd a named MPSK configRead MPSK Usage StatsDelete an MPSK network configuration.Edit a Named MPSK ConfigRead all named MPSKRead a named MPSK configEdit an MPSK network configCreate an MPSK network configRead all configured MPSK networks.Delete a Named MPSK ConfigRead one MPSK network config.
Authentication & Policy-File Upload
Upload fileTerminate UploadRead upload status of last file uploadTerminate UploadUpload fileRead errors in last file uploadRead errors in last file uploadRead upload status of last file upload
Authentication & Policy-MAC Registration
Update registered client name.Add mac registration.Fetch list of mac registrations.Delete registered mac registration.
Authentication & Policy-User Management
Fetches certificate details of a userRevoke a user's device certificate
Ble Beacon Service-BleBeaconService
Edit ble beacon profileRetrieve ble beacon profilesRetrieve ble configured beaconsDelete one device beacon configRetrieve ble running beaconsUpdate one device beacon configDelete ble beacon profileConfig ble beacon profile
Client Match-Status
Get the status of Client Match Load Balancer for a tenantEnable or disable Client Match Band Steer to 6GHz for a particular tenant.Enable or disable Client Match Load Balancer for a particular tenant.Get the status of Client Match for a tenantEnable or disable Client Match for a particular tenant.Get the status of Client Match Band Steer to 6GHz for a tenant
Client Match-Unsteerable
Get the unsteerable state of a clientDelete the unsteerable state of a clientGet all unsteerable entries for a tenantSet the unsteerable state of a client
Cloud Connect-Cloud Connect
Creates a new Custom Cloud Account with name as account_nameUpdate Prisma cloud provider endpoint configGet config summary for configured groups.Trigger cloud provider endpoint scan.Delete Custom cloud provider endpoint configDelete AWS cloud provider endpoint configUpdate Zscaler cloud provider endpoint configDelete Tunnel Policy with name as policy_nameGet the Prisma Account Configuration for account_nameUpdates an existing Prisma Cloud Account with name as account_nameGet the list of all Tunnel Policy ConfigurationsDelete Azure cloud provider endpoint configUpdate Custom cloud provider endpoint configGet Zscaler node scan details.Update AWS cloud provider endpoint configGet all Cloud Provider endpoints.Create Custom cloud provider endpoint configDelete Prisma cloud provider endpoint configGet the Custom Cloud Account Configuration for account_nameGet configured vlan list for each cloud connect endpoint.Creates a new Prisma Cloud Account with name as account_nameCreate Prisma cloud provider endpoint configCreates a new Tunnel Policy with name as policy_nameGet the Tunnel Policy Configuration for policy_nameCreate Zscaler cloud provider endpoint configGet the list of valid Tunnel Policy configurationsUpdate Azure cloud provider endpoint configCreate AWS cloud provider endpoint configUpdates an existing Tunnel Policy with name as policy_nameDelete Zscaler cloud provider endpoint configCreate Azure cloud provider endpoint configDelete Prisma Cloud Account with name as account_nameDelete Custom Cloud Account with name as account_nameUpdates an existing Custom Cloud Account with name as account_name
Deprecated Device Inventory-Devices
Get status of refresh job(Deprecated) Get devices from device inventorySchedule a job to refresh the device inventoryGet devices statsAdd device using Mac and Serial numberVerify device additionGet devices from device inventory(Deprecated) Add device using Mac and Serial number(Deprecated) Get devices stats
Deprecated Device Inventory-Private Cloud Devices
Get device from device inventory
Deprecated Licensing-Subscriptions
MSP API:- Assign licenses to all the devices owned by tenant customers.(Deprecated) Get user subscription keysStandalone customer API:- Assign licenses to all devices.MSP API:- Remove service licenses to all the devices owned by tenants and MSP.(Deprecated) Assign subscription to a device(Deprecated) Get enabled services for customer(Deprecated) Get subscription statsStandalone customer API:- Un-assign licenses to all devices for given services.(Deprecated) Unassign subscription to a device(Deprecated) Get services licensing config
Deprecated Licensing-Auto-License
(Deprecated) MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.(Deprecated) Standalone Customer API:- Disable auto licensing for given services.(Deprecated) Get services and corresponding license token availability status.(Deprecated) Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.(Deprecated) Get auto enabled services for msp or tenant customer.(Deprecated) Get the services which are auto enabled.(Deprecated) MSP API:- Disable auto license settings at msp and its tenant level for given services.
Device Management-ActionCommand
Generic Action Command for bouncing interface or POE (power-over-ethernet) portGeneric commands for deviceGeneric Action Command for bouncing interface or POE (power-over-ethernet) portStatusSpeed TestGeneric commands for swarmDisconnect User
Device Management-DMS
Delete Mobility Master to Mobility Device mappingGet assigned Mobility Master to Mobility Device.Statically assign Mobility Master to Mobility Device.
Device Replacement-Offline Devices
Get all offline devices
Device Replacement-Request Replacement
To request device replacement
Device Replacement-Check Compliance
To check compliance
Device Replacement-Initiate Replacement
To initiate device replacement
Device Replacement-Cancel Replacement
To cancel device replacement
Device Replacement-Devices Under Replacement
To get devices under replacement
Device Replacement-Device status
To check device status
Device Replacement-Device count
To get device count for a Tenant/Standalone account
Device Replacement-MSP Replacement Count
Count of devices under replacement for a MSP customer
Device Replacement-Get MSP customers
Get all tenants under that MSP account
Device Replacement-MSP replacement details
Get replacement details of all tenants under that MSP account
Device Routing - BGP-Neighbor
List BGP neighbor InformationList of routes learned form a BGP neighborList of routes advertised to a BGP neighborGet BGP neighbor detailed informationReset/clear BGP neighbor session
Device Routing - BGP-Route
List BGP routes
Device Routing - OSPF-Area
List OSPF Area Information
Device Routing - OSPF-Interface
List OSPF Interface Information
Device Routing - OSPF-Neighbor
List OSPF neighbor Information
Device Routing - OSPF-LinkStateDatabase
List OSPF Link State Database Information
Device Routing - Overlay-Connection
Get information about overlay control connectionReset overlay control connection
Device Routing - Overlay-Interface
List of overlay interfaces (tunnels)
Device Routing - Overlay-RouteLearned
List of learned routes from overlay
Device Routing - Overlay-RouteLearnedBest
List of best learned routes from overlay
Device Routing - Overlay-RouteAdvertised
List of advertised routes to overlay
Device Routing - RIP-Interface
List RIP interfaces
Device Routing - RIP-Neighbor
List RIP neighborsList of routes learned from a RIP neighbor
Device Routing - RIP-Route
List RIP routes
Device Routing - RouteTable-Route
Get legacy routesGet routes
DPS Monitoring-DPS
DPS Compliance percentage of all DPS Policies for a given BOC.Gets DPS Policy stats for a given BOC.Gets DPS Compliance stats for a given Site.DPS Compliance Status of all DPS Policies for a given BOC.DPS Key Performance Indicator for a given BOC.Gets DPS Policy Event Logs for a given BOC.Gets DPS Policy stats for a given BOC.
Firmware-Firmware Management
Firmware UpgradeCancel Scheduled Upgrade at Customer LevelList Firmware Details of SwarmsClear Firmware Compliance Version for TenantSet Firmware Compliance VersionFirmware Upgrade at MSP LevelSet Firmware Compliance Version for MSP customerList Firmware VersionCancel Scheduled UpgradeSet Firmware Compliance Version for TenantFirmware Details of SwarmClear Firmware Compliance VersionFirmware Details of DeviceFirmware StatusList Model FamilySet Firmware Compliance Version CustomerGet Firmware Compliance Version for MSP CustomerGet Firmware Compliance Version for TenantGet Firmware Compliance VersionCancel Scheduled Upgrade at MSP LevelFirmware VersionList Firmware Details of a TenantClear Firmware Compliance Version for MSP CustomerList Firmware Details of DevicesFirmware Upgrade at Customer LevelCancel Scheduled Upgrade at MSP LevelCancel Scheduled Upgrade at Customer Level
GDPR-GDPR
Delete Opt out MacGDPR Opt out MACAdd Gdpr opt out clientList gdprs opt out MAC clients for this customer
Guest-Portals
Create a new guest portal profileGet guest portal profileUpdate guest portal profileGet all portals with limited dataGet preview url of guest portal profileDelete guest portal profile
Guest-Sessions
Get all sessions of a ssid
Guest-Visitors
Delete guest visitor accountGet all visitors created against a portalGet guest visitor accountCreate a new guest visitor of a portalUpdate guest visitor account
Guest-Wlans
Get all guest wlans
Guest-Troubleshoot
Check if guest is enabled for current user.Provision cloud guest for current customer
Guest-WiFi4EU
WiFi4EU Status
Guest-Summary
Get summary statistics
Install Manager-Installer
Delete an installerInvite a new installerUpdate an installerGet all installers
Install Manager-QR code
Get QR code listCreate a QR codeDelete a QR codeUpdate a QR code
Install Manager-Sites
Get all assigned group to sites listUpdate site statusFor a given set of site names, assign Group Names for each device type
IoT - App Developer Portal-Apps
Get App Version DetailsCreate AppList App VersionsDelete App VersionEdit Draft AppWithdraw App VersionList Draft AppsList Published and Suspended AppsValidate App NameSubmit App
IoT - App Developer Portal-Container Image
List ImagesList Images For Max VersionValidate Image NameUpload Image
IoT - Appstore-App Store
Upgrade appEdit Developer installed app configurationSearch appsDeveloper infoUpgrade developer appInstall appGet App IconFind Recommended AppsEdit Installed app configurationCount all installed appsGet Developer AppInstall Developer appDelete Developer appGet the last 10 versions of an AppDeveloper appsFind all installed appsGet Developer App IconGet AppDelete app
IoT - Device-Devices
Return the count of devices by Device ClassReturn the count of devices with one or more device classesReturn a time-series device count by collectorIdReturn the count of devicesReturn Pageable List of all devicesReturn the count of devices reporters by CollectorReturn Pageable List of all devicesReturn a device by IdReturn Pageable List of AttributesReturn the count of devices by typeReturn the time-series from device
IoT - Iotgateway-association
Return Pageable List of GatewaysReturn Pageable List of GatewaysAdd AssociationDelete AssociationReturns security token associated with a collector
IoT - Iotgateway-groups
Group moveGroup moveReturns connector to group mapping
IoT - Iotgateway-iot_gateways
Return Pageable List of GatewaysReturn Pageable List of GatewaysReturn a Gateway by cluster Id
IoT - Transport Profile-Transport Profile
Get a list of all device classesUpdate a transport profile by idGet a transport profile by idCount transport profilesCreate a transport profileFind transport profilesDelete a transport profile by id
Monitoring-AP
Top N AP DetailsAP RF SummaryList Access PointsDelete APList BSSIDsAP Bandwidth UsageAP Details
Monitoring-Network
WLAN Network Bandwidth usageGet Network detailsList all Networks
Monitoring-Client
Wireless Client Mobility TrailConnected Wired Client DetailsConnected Wireless Client DetailsClient DetailsClient Bandwidth UsageList Unified Clients (Wired/Wireless). Option to choose Connected/Failed ClientsList Connected Wired ClientsList Connected Wireless ClientsTop N ClientsTotal Clients Count
Monitoring-Swarm
Top N Swarms By Bandwidth UsageList SwarmsSwarm DetailsTop N Swarms By Clients Count
Monitoring-Label
Unassociate Label from deviceCreate LabelList Default LabelsUnassociate a label from a list of devicesAssociate Label to a list of devicesUpdate LabelLabel detailsAssociate Label to deviceList LabelsDelete LabelList Label Categories
Monitoring-Site
Unassociate a site from a list of devicesUpdate SiteCreate SiteAssociate Site to deviceUnassociate Site from deviceList SitesAssociate Site to a list of devicesSite detailsDelete Site
Monitoring-Switch
Switch Chassis DetailsGet vlan info of the switchSwitch Stack DetailsGet switch poe info for CX switchGet switch vsx info for CX switchPorts Bandwidth Usage for CX SwitchDelete SwitchList SwitchesSwitch Ports DetailsTop N SwitchesGet switch poe infoCX Switch Stack Port DetailsGet vlan info of the switch stackSwitch Bandwidth UsageSwitch Stack Port DetailsGet lldp device neighbor info for CX switch stackDelete Switch StackGet vlan info for CX switchList Switch StacksSwitch DetailsGet vlan info of the CX switch stackSwitch Ports Bandwidth UsageSwitch Ports ErrorsGet switch port poe infoGet switch port poe info for CX switchCX Switch Ports ErrorsGet lldp device neighbor info for CX switchGet ports details for CX switch
Monitoring-Events
(Deprecated) List EventsList Events
Monitoring-VPN
Swarm VPN statsVpn Details
Monitoring-MobilityController
Delete Mobility ControllerList Mobility ControllersMobility Controllers Ports Bandwidth UsageDelete Mobility ControllerMobility Controllers Ports DetailsMobility Controller DetailsMobility Controller DetailsMobility Controllers VLAN detailsList Mobility Controllers
Monitoring-Gateway
Gateway Ports DetailsDelete GatewayGateway Uplink WAN compression statsGateway DHCP Pools detailsGateway Uplink tunnel statsGateway Port ErrorsGateway VLAN detailsGateway Tunnels DetailsGateway Uplink Bandwidth UsageGateway Ports Bandwidth UsageGateway DetailsGateway Uplink distributionGateway Uplink DetailsGateway DHCP Clients informationGateway List
MSP-Customers
(Deprecated) Update a customerDelete a customerGet details of customer(Deprecated) Create a new customerGet list of customers under the MSP account based on limit and offsetUpdate a customerCreate a new customer
MSP-Devices
Get list of devices and licenses under the MSP account based on limit and offset, offset should be a multiple of the limit valueUn-assign all devices from Tenant/end-customer.Move a device to an end-customerGet list of devices and licenses under the Customer account based on limit and offset, offset should be a multiple of the limit value
MSP-Resources
Get the resource under the MSPEdit an existing resource for the MSP
MSP-Users
Get list of users under the MSP account based on limit and offsetGet list of users under the Customer account based on limit and offset
MSP-Groups
Get list of customers mapped to MSP group based on limit and offset.
MSP-Get Country Code
Get list of country code
Network Health-Network Health
Get data for all sites
New Device Inventory-Devices
(Deprecated) Schedule a job to refresh the device inventory(Deprecated) Get status of refresh jobGet Archived devices from device inventoryArchive devices using Serial listDelete devices using Serial numberGet devices statsAdd device using Mac and Serial numberUnarchive devices using Serial listGet devices from device inventoryVerify device addition
New Device Inventory-Private Cloud Devices
Get device from device inventory
New Device Inventory-MSP Devices
assign the device to the end-customerA filterable paginated response of a list of devices and licenses under the MSP account based on the provided limit and offset parameters.A filterable paginated response of a list of devices and licenses under the customer account based on the provided limit and offset parameters
New Licensing-Subscriptions
Unassign subscription to a deviceGet subscription statsStandalone customer API:- Assign licenses to all devices.MSP API:- Assign licenses to all the devices owned by tenant customers.Get user subscription keysStandalone customer API:- Un-assign licenses to all devices for given services.Assign subscription to a deviceGet services licensing configMSP API:- Remove service licenses to all the devices owned by tenants and MSP.Get enabled services for customer
New Licensing-Auto-License
Get the services which are auto enabled.Get services and corresponding license token availability status.MSP API:- Disable auto license settings at msp and its tenant level for given services.Standalone Customer API:- Assign licenses to all devices and enable auto licensing for given services.MSP API:- Enable auto license settings and assign services to all devices owned by tenant customers.Standalone Customer API:- Disable auto licensing for given services.Get auto enabled services for msp or tenant customer.
Notification-Notification
List NotificationsAcknowledge Notifications by ID List / AllAcknowledge NotificationGet notifications count by severity
Notification-Types
List Types
Notification-Settings
Get Customer account level SettingsUpdate settings detailsAdd settingsDelete SettingsUpdate customer settingsList Settings
Presence Analytics-Config
it retrieves RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.It retrieves visitor RSSI threshold, passerby RSSI threshold, dwell time threshold, access points and site name for site level configuration.It configures RSSI threshold, dwelltime threshold for visitor & RSSI threshold for passerby.it configure RSSI threshold, Dwelltime threshold for visitor & RSSI threshold for Passerby.It retrieves RSSI threshold for passerby conversion, RSSI threshold for visitor conversion & dwelltime threshold for passerby to visitor conversion.
Presence Analytics-Associated
Get details of connected and non connected visitors.
Presence Analytics-Loyalty
Get Bottom 5 sites Loyalty trends.Get loyalty aggregate values for list of sitesGet loyalty visits of visitors in histogramGet loyalty indicator trendsGet Bottom 5 sites Loyalty indicator aggregate values.Get Top 5 sites Loyalty indicator aggregate values.Get Top 5 sites Loyalty trends.Get loyalty indicator aggregate valuesGet presence analytics trends.Get loyalty visitors frequency.
Presence Analytics-PresenceStats
Get presence analytics trends.Get presence analytics trendsGet presence analytics metrics aggregate values
Presence Analytics-License
Enable or disable PA license.List of devices per site with their pa license status.Customer level device license status.
Presence Analytics-Insights
Get presence aggregate values for list of sitesGet Bottom 5 sites aggregate values.Get Top 5 sites aggregate values.Get presence aggregate values for list of sites.
RAPIDS-Rogues
List suspect APsList manually contained APsList Interfering APsList neighbor APsList Rogue APs
RAPIDS-WIDS
List Infrastructure AttacksList Client AttacksWIDS Events
Reporting-Reports
Generated ReportsScheduled ReportsGenerated ReportsScheduled Reports
Reporting-SDWAN Reports
SDWAN DPS policy compliance report
Service Airgroup-Aruba airgroup
Retrieve complete visibility ap_list for given serverDelete complete Airgroup config for given Global or GroupRetrieve all airgroup service policies at given Global or groupCreate allowed vlan for given serviceCreate/Update airgroup server config by mac_addressCreate service-id mapping for given standard serviceDelete disallowed role for given serverDelete custom service for given nameCreate/Update Personal device visibility configurationRetrieve role restrictions for given airgroup serverCreate disallowed vlan for given serviceCreate/Update entry for serial_number in visibility ap_list for given serverDelete allowed role for given serviceCreate/Update allowed vlan for given serviceRetrieve all service-ids for given standard serviceRetrieve node_list by identifier node-type node-idDelete General settings for given Global or GroupDelete role restrictions for given airgroup serverDelete airgroup server config by mac_addressCreate entry for serial_number in visibility ap_list for given serverRetrieve airgroup server config by mac_addressRetrieve all disallowed vlans for given serviceDelete role restrictions for given service at global or groupRetrieve all allowed roles for given serverCreate/Update allowed role for given serviceCreate/Update entry in admin user-ids for given user_idDelete allowed role for given serverCreate/Update airgroup_statusCreate vlan restriction for given service at Global or groupCreate standard service for given nameCreate/Update role restrictions for given service at global or groupCreate/Update service-id for given custom serviceRetrieve complete Airgroup config for given Global or GroupDelete service-id for given custom serviceRetrieve all allowed vlans for given serviceCreate/Update disallowed role for given serverRetrieve entry in admin user-ids for given user_idRetrieve service-id for given custom serviceDelete network visibility config for given airgroup serverCreate/Update standard service for given nameRetrieve role restrictions for given service at global or groupCreate allowed role for given serviceCreate airgroup service policy by name at Global or groupDelete airgroup service policy by name at Global or groupCreate airgroup server config by mac_addressCreate/Update vlan restriction for given service at Global or groupCreate/Update disallowed vlan for given serviceRetrieve airgroup service policy by name at Global or groupCreate/Update network visibility config for given airgroup serverCreate disallowed role for given serviceCreate custom service for given nameCreate General settings for given Global or GroupCreate airgroup_statusRetrieve disallowed role for given serviceRetrieve service-id mapping for given standard serviceDelete vlan restriction for given service at Global or groupRetrieve allowed role for given serviceDelete allowed vlan for given serviceRetrieve vlan restriction for given service at Global or groupRetrieve disallowed role for given serverRetrieve all disallowed roles for given serverRetrieve all standard Airgroup service definitionsRetrieve all user-ids treated as admin users for device visibilityRetrieve Personal device visibility configurationRetrieve allowed vlan for given serviceRetrieve General settings for given Global or GroupRetrieve allowed role for given serverCreate disallowed role for given serverRetrieve disallowed vlan for given serviceRetrieve common_configCreate role restrictions for given airgroup serverRetrieve all allowed roles for given serviceCreate/Update role restrictions for given airgroup serverDelete entry for serial_number in visibility ap_list for given serverRetrieve entry for serial_number in visibility ap_list for given serverDelete disallowed role for given serviceCreate service-id for given custom serviceRetrieve all disallowed roles for given serviceCreate/Update General settings for given Global or GroupCreate/Update service-id mapping for given standard serviceDelete entry in admin user-ids for given user_idRetrieve all custom service definitionsCreate/Update disallowed role for given serviceCreate/Update allowed role for given serverRetrieve all service-ids in given custom serviceRetrieve network visibility config for given airgroup serverDelete disallowed vlan for given serviceRetrieve standard service for given nameCreate allowed role for given serverRetrieve airgroup_statusRetrieve custom service for given nameDelete airgroup_statusCreate role restrictions for given service at global or groupCreate/Update airgroup service policy by name at Global or groupCreate entry in admin user-ids for given user_idCreate network visibility config for given airgroup serverDelete Personal device visibility configurationCreate/Update custom service for given nameCreate Personal device visibility configurationRetrieve all configured airgroup servers
Service Airmatch-Aruba airmatch
Delete systemCreate configRetrieve node_list by identifier node-type node-idCreate/Update configCreate/Update systemCreate systemDelete configRetrieve systemRetrieve config
Service IDS IPS-Aruba ids ips
Create complete config for IDS/IPSCreate/Update SIEM server notification configurationDelete SIEM server notification configurationDelete complete config for IDS/IPSCreate/Update SIEM server config for given siem_server_nameRetrieve SIEM server config for given siem_server_nameDelete SIEM server config for given siem_server_nameRetrieve complete config for IDS/IPSCreate SIEM server notification configurationRetrieve SIEM server notification configurationCreate/Update complete config for IDS/IPSRetrieve node_list by identifier node-type node-idRetrieve config for all SIEM serversCreate SIEM server config for given siem_server_name
Service IPMS-Aruba ipms
Create IP address pool for given pool_nameRetrieve node_list by identifier node-type node-idCreate/Update IP range by range_id for given address pool_nameRetrieve all IP ranges for given address pool_nameCreate/Update IP address pool for given pool_nameCreate IP range by range_id for given address pool_nameRetrieve all IP address poolsRetrieve IP range by range_id for given address pool_nameRetrieve complete IPMS configDelete IP address pool for given pool_nameRetrieve IP address pool for given pool_name
Service Overlay Wlan-Aruba overlay wlan
Delete Cluster mapping for given profile and profile_typeRetrieve all Profile to Cluster mappings for given groupDelete Complete Overlay-wlan config for given groupRetrieve Complete Overlay-wlan config for given groupDelete Cluster mapping by redundancy-type and group-name for given profile and typeCreate/Update Cluster mapping by redundancy-type and group-name for given profile and typeCreate Complete Overlay-wlan config for given groupCreate/Update Complete Overlay-wlan config for given groupRetrieve Cluster mapping for given profile and profile_typeCreate Cluster mapping by redundancy-type and group-name for given profile and typeRetrieve all Cluster mappings for given profile and typeCreate/Update Cluster mapping for given profile and profile_typeRetrieve node_list by identifier node-type node-idCreate Cluster mapping for given profile and profile_typeRetrieve Cluster mapping by redundancy-type and group-name for given profile and type
Service RAPIDS-Aruba Rapids
Retrieve essid in include SSIDs for given classification rule_nameCreate/Update essid in include SSIDs for given classification rule_nameCreate essid in include SSIDs for given classification rule_nameDelete essid in include SSIDs for given classification rule_nameRetrieve all include SSIDs for given classification rule_nameRetrieve essid in exclude SSIDs for given classification rule_nameCreate/Update essid in exclude SSIDs for given classification rule_nameCreate essid in exclude SSIDs for given classification rule_nameDelete essid in exclude SSIDs for given classification rule_nameRetrieve all exclude SSIDs for given classification rule_nameRetrieve site by name in Site-Includes for given classification rule_nameCreate/Update site by name in Site-Includes for given classification rule_nameCreate site by name in Site-Includes for given classification rule_nameDelete site by name in Site-Includes for given classification rule_nameRetrieve all sites in Site-Includes for given classification rule_nameRetrieve site by name in Site-Excludes for given classification rule_nameCreate/Update site by name in Site-Excludes for given classification rule_nameCreate site by name in Site-Excludes for given classification rule_nameDelete site by name in Site-Excludes for given classification rule_nameRetrieve all sites in Site-Excludes for given classification rule_nameRetrieve match criteria for given classification rule_nameCreate/Update match criteria for given classification rule_nameCreate match criteria for given classification rule_nameDelete match criteria for given classification rule_nameRetrieve Classification rule by ruel_nameCreate/Update Classification rule by ruel_nameCreate Classification rule by ruel_nameDelete Classification rule by ruel_nameRetrieve all Classification rulesRetrieve complete RAPIDS configurationCreate/Update complete RAPIDS configurationCreate complete RAPIDS configurationDelete complete RAPIDS configurationRetrieve node_list by identifier node-type node-id
Service SDWAN-Branch Mesh
Create/Update branch-mesh config for given labelRetrieve all branch-devices for given branch-mesh labelCreate branch-mesh config for given labelRetrieve branch-mesh by labelRetrieve branch-devices by device serial numberRetrieve branch-mesh config for given labelDelete branch-devices by device serial numberDelete branch-mesh config for given labelCreate branch-devices by device serial numberCreate/Update branch-devices by device serial numberRetrieve branch-mesh config for all labels
Service SDWAN-Hub Configuration
Delete global hub configurationRetrieve DC aggregate routes for given network segmentCreate DC aggregate routes for given network segmentCreate transitRetrieve all DC aggregate route prefixes for given network segmentDelete transitCreate/Update DC aggregate routes for given network segmentDelete DC aggregate routes for given network segmentRetrieve transitRetrieve DC aggregate routes for all network segmentsCreate DC aggregate routes by prefix for given network segmentCreate/Update transitDelete DC aggregate routes by prefix for given network segmentCreate/Update DC aggregate routes by prefix for given network segmentRetrieve global hub configurationRetrieve DC aggregate routes by prefix for given network segment
Service SDWAN-DC Preference
Retrieve all hubs-clusters for given branch groupRetrieve hub-clusters by cluster name and cluster groupRetrieve hubs by device serial numberDelete hub-clusters by cluster name and cluster groupCreate/Update branch/micro-branch configurationCreate hub-clusters by cluster name and cluster groupDelete branch/micro-branch configurationRetrieve all hub devices for given branch groupDelete hubs by device serial numberRetrieve branch/micro-branch configurationCreate branch/micro-branch configurationCreate/Update hub-clusters by cluster name and cluster group
Service SDWAN-Microbranch Data-Center
Create/Update microbranch-dc-clusterRetrieve hub-clusters by identifier cluster-name cluster-groupCreate hub-clusters by identifier cluster-name cluster-groupCreate/Update hub-clusters by identifier cluster-name cluster-groupDelete hub-clusters by identifier cluster-name cluster-groupRetrieve hub-clustersDelete microbranch-dc-clusterRetrieve microbranch-dc-clusterCreate microbranch-dc-cluster
Service SDWAN-Global Settings
Delete admin-statusCreate/Update topologyDelete topologyRetrieve topologyCreate topologyRetrieve admin-statusRetrieve sdwan-globalCreate/Update admin-statusDelete sdwan-globalCreate admin-status
Service SDWAN-Network Segments
Create network-segment-policy by segment nameDelete network-segment-policy by segment nameRetrieve network-segment-policy by segment nameCreate/Update network-segment-policy by segment nameRetrieve network-segment-policy config for all segments
Service SDWAN-Route Policy
Retrieve global load-balance orchestration configurationCreate best-path-computationCreate/Update best-path-computationRetrieve as-numberCreate/Update as-numberRetrieve global hub route policy configurationCreate timerDelete global graceful restart timer configurationCreate/Update global load-balance orchestration configurationDelete best-path-computationRetrieve global graceful restart timer configurationCreate global graceful restart timer configurationRetrieve best-path-computationCreate/Update global hub route policy configurationCreate/Update global graceful restart timer configurationDelete timerDelete route-policyDelete global load-balance orchestration configurationDelete as-numberRetrieve route-policyCreate/Update timerCreate global hub route policy configurationCreate as-numberDelete global hub route policy configurationCreate global load-balance orchestration configurationRetrieve timer
Service SDWAN-Branch Aggregates
Create/Update global branch aggregate routes for given network segmentCreate global branch aggregate routes for given network segmentDelete global branch aggregate routes for given network segmentCreate global branch aggregate routes by prefix for given network segmentDelete global branch aggregate routes by prefix for given network segmentRetrieve global branch aggregate routes by prefix for given network segmentRetrieve all branch-aggregate prefixes for given segmentRetrieve branch-aggregate prefixes for all segmentsCreate/Update global branch aggregate routes by prefix for given network segmentRetrieve global branch aggregate routes for given network segment
Service SDWAN-Tunnel Policy
Retrieve tunnel-policyDelete rekey-intervalCreate rekey-intervalCreate tunnel-policyCreate/Update rekey-intervalRetrieve rekey-intervalDelete tunnel-policyCreate/Update tunnel-policy
Service SDWAN-Hub Mesh
Retrieve hub-mesh by labelRetrieve all hub-groups for given hub-mesh labelCreate/Update hub-groups by nameDelete mesh-policyRetrieve hub-mesh config for all labelsCreate hub-mesh by labelCreate hub-groups by nameCreate/Update hub-mesh by labelRetrieve mesh-policyDelete hub-groups by nameDelete hub-mesh by labelRetrieve hub-groups by name
Service SDWAN-Group Configuration
Retrieve SDWAN global/group configurationDelete SDWAN global/group configuration
Service SDWAN-aruba_sdwan
Retrieve node_list by identifier node-type node-id
Service UCC-Aruba ucc
Retrieve DSCP Priority configuration for 'Skype for Business'Create/Update DSCP Priority configuration for 'Skype for Business'Create DSCP Priority configuration for 'Skype for Business'Delete DSCP Priority configuration for 'Skype for Business'Retrieve 'dns_patterns' config for given dns_patternCreate/Update 'dns_patterns' config for given dns_patternCreate 'dns_patterns' config for given dns_patternDelete 'dns_patterns' config for given dns_patternRetrieve all configured DNS patternsRetrieve DSCP Priority configuration for Wifi CallingCreate/Update DSCP Priority configuration for Wifi CallingCreate DSCP Priority configuration for Wifi CallingDelete DSCP Priority configuration for Wifi CallingRetrieve DSCP Priority configuration for SIP ALGCreate/Update DSCP Priority configuration for SIP ALGCreate DSCP Priority configuration for SIP ALGDelete DSCP Priority configuration for SIP ALGRetrieve DSCP Priority configuration for MS TeamsCreate/Update DSCP Priority configuration for MS TeamsCreate DSCP Priority configuration for MS TeamsDelete DSCP Priority configuration for MS TeamsRetrieve ucc_algCreate/Update ucc_algCreate ucc_algDelete ucc_algRetrieve activateCreate/Update activateCreate activateDelete activateRetrieve UCC settingsCreate/Update UCC settingsCreate UCC settingsDelete UCC settingsRetrieve complete UCC configCreate/Update complete UCC configCreate complete UCC configDelete complete UCC configRetrieve node_list by identifier node-type node-idCreate/Update DSCP Priority configuration for ZoomDelete DSCP Priority configuration for ZoomRetrieve DSCP Priority configuration for ZoomCreate DSCP Priority configuration for Zoom
SSO Configuration-SSO Support
Un-claim domainUpdate IDP configurationExtract Saml metadata from fileGet saml metadataAdd IDP configGet domain list
Topology-Topology
Get details of an uplink.Get neighbor details reported by AP via LLDP.Get list of unreachable devices in a site.Get details of an edge.Get details of an edge for the selected source and destination.Get details of a device.Get topology details of a site.Get vlan list of a site.Get tunnel details.
Troubleshooting-Troubleshooting
List Troubleshooting CommandsClear Troubleshooting SessionStart Troubleshooting SessionInitiate Running Config Backup For A Single DeviceInitiate Running Config Backup For All Devices In A GroupStart Troubleshooting Session For CX DeviceList Troubleshooting CX CommandsGet Troubleshooting OutputGet Troubleshooting Session IDGet list of backups associated with the device serialGet list of backups associated with the device serial with the given prefixFetch the backup stored against the given name
Troubleshooting-Action Command
Action command for enroll est certificate
UnifiedCommunications-Summary
Fetch Summary
UnifiedCommunications-UC Clients
Fetch number of Clients
UnifiedCommunications-Session counts by session type
Fetch session counts based on session type
UnifiedCommunications-Session counts by alg
Fetch session counts based on alg name
UnifiedCommunications-Session quality by Session type
Fetch session quality based on session type
UnifiedCommunications-Session quality by SSID
Fetch session quality based on ssid
UnifiedCommunications-Insights count
Fetch number of insights for a day
UnifiedCommunications-Insights
Fetch insights for a day. start time 00:00:00 and end time 23:59:59
UnifiedCommunications-CDR
Fetch list of CDRsExport list of CDRs
UnifiedCommunications-SkypeCentralURL
Fetch skype server central termination URL
User Management-Users
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 eReset user passwordDelete user account details specified by user idCreate a user accountGet user account details specified by user idList user accountsChange user password
User Management-Bulk Users
Get task statusCreate multiple users account. The max no of accounts that can be created at once is 10.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 accountDelete multiple users account. The max no of accounts that can be deleted at once is 10.
User Management-Roles
Get Role detailsUpdate a roleGet list of all rolesCreate a role in an appDelete a role
Vgw-Get Cloud Accounts
Configure Cloud account for provider AzureConfigure Cloud account for provider AWSConfigure Cloud account for provider Zscaler
Vgw-Create Cloud Account
Create Cloud Account for Provider (AWS/Azure/Zscaler)
Vgw-Edit Cloud Account
Edit Cloud Account for Provider (Azure/Zscaler)
Vgw-Delete Cloud Account
Delete cloud account for by account-id
VisualRF-Client Location
Get a specific floor and location of all its clientsGet location of a specific client
VisualRF-Rogue Location
Get a specific floor and location of all its rogue access pointsGet location of a specific rogue access point
VisualRF-Floorplan
Get list of all campusesGet details of a specific floorGet a specific floor and location of all its access points Get a specific campus and its buildingsGet location of a specific access pointGet a specific building and its floorsGet background image of a specific floor
VisualRF-Import
get last import operation informationcreate floorplans using zip file (supported files are zip and .esx)
VisualRF-Anonymization
Disable anonymizationEnable anonymizationGet status of anonymization
VisualRF-GeoFence
Enable geofenceGet status of geofenceDisable geofence
Webhook-Webhooks
Add WebhookDelete WebhooksWebhook setting for a specific itemList webhooksUpdate webhook settingsRefresh the webhook tokenTest for webhook notificationGet Webhook Token
HomeHPE Aruba Networking CentralAirGroup-Distribution

AirGroup-Distribution

Number of APIs: 2

  1. Retrieves a summary of all the services queried for. GET {{base_url}}/airgroup/v1/distribution/services?start_time=<long>&end_time=<long>&label=<string>

  2. Retrieves a summary of the servers connected to AirGroup GET {{base_url}}/airgroup/v1/distribution/servers?start_time=<long>&end_time=<long>&label=<string>

Previous
Retrieves list of labels
Next
Retrieves a summary of all the services queried for.