ACP Audit Trail

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

ACP OFC Api Handler

Flowhandler

AIOps

Wi-Fi Connectivity Dashboard
AI Insights List
AI Insight Details

AirGroup

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

AirMatch

Radio
AP
Telemetry
- Bootstrappost
- Purgepost
Solution
Miscellaneous
Schedule
Radio feasibility
Deployer
RF domain
- Get partition informationget
- Start partition processpost

AppRF

Overview
- (Deprecated) Gets Top N Apprf Statisticsget
- Gets Top N Apprf Statistics (V2 Version)get
Applications
- Gets Top N Applicationsget
Web Categories
- Gets Top N Web categoriesget
App Categories
- Gets Top N App categoriesget
Web Reputations
- Gets Top Web Reputationsget
AppRF IAP Meta Info

Audit Event Logs

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

Authentication & Policy

Authentications and Sessions
Client Policy
Client Registration
Wi-Fi Easy Connect
User Policy
Download
- Fetch all Named MPSK as a CSV file.get
- Fetch all Mac Registrations as a CSV file.get
MPSK Networks Configs
File Upload
MAC Registration
User Management
- Fetches certificate details of a userget
- Revoke a user's device certificatepost

Ble Beacon Service

BleBeaconService

Client Match

Status
Unsteerable

Cloud Connect

Cloud Connect

Configuration

Groups
Pre Provisioned Group
- Pre Provision a group to the devicepost
- Assign Pre-Provisioned Grouppost
Templates
Configuration backup and restore
Devices
Variables
MM-MD
- Trigger Mobility Device recovery by resetting (delete and add) Device configuration.post
Certificates
Captive portal logo
MSP Templates
Configuration Mode
Variables firewall
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
denylist clients
WLAN Configuration
AP Settings
AP Configuration
Swarm Config
AOS-S

DPS Monitoring

Deprecated Device Inventory

Devices
Private Cloud Devices
- Get device from device inventoryget

Deprecated Licensing

Subscriptions
Auto-License

Device Management

ActionCommand
DMS

Device Replacement

Offline Devices
- Get all offline devicesget
Request Replacement
- To request device replacementpost
Check Compliance
- To check compliancepost
Initiate Replacement
- To initiate device replacementpost
Cancel Replacement
- To cancel device replacementpost
Devices Under Replacement
- To get devices under replacementget
Device status
- To check device statusget
Device count
- To get device count for a Tenant/Standalone accountget
MSP Replacement Count
- Count of devices under replacement for a MSP customerget
Get MSP customers
- Get all tenants under that MSP accountget
MSP replacement details
- Get replacement details of all tenants under that MSP accountget

Device Routing - BGP

Neighbor
Route
- List BGP routesget

Device Routing - OSPF

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

Device Routing - Overlay

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

Device Routing - RIP

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

Device Routing - RouteTable

Route
- Get routesget
- Get legacy routesget

Firmware

Firmware Management

GDPR

GDPR

Guest

Portals
Visitors
Sessions
- Get all sessions of a ssidget
Wlans
- Get all guest wlansget
Troubleshoot
- Check if guest is enabled for current user.get
- Provision cloud guest for current customerpost
WiFi4EU
- WiFi4EU Statuspost
Summary
- Get summary statisticsget

Install Manager

Installer
QR code
Sites

IoT - App Developer Portal

Apps
Container Image

IoT - Appstore

App Store

IoT - Device

Devices

IoT - Iotgateway

iot_gateways
association
groups

IoT - Transport Profile

Transport Profile

MSP

Customers
Get Country Code
- Get list of country codeget
Users
- Get list of users under the MSP account based on limit and offsetget
- Get list of users under the Customer account based on limit and offsetget
Resources
- Get the resource under the MSPget
- Edit an existing resource for the MSPput
Devices
Groups
- Get list of customers mapped to MSP group based on limit and offset.get

Monitoring

Network
AP
Swarm
Client
VPN
- Vpn Detailsget
- Swarm VPN statspost
MobilityController
Gateway
Label
Site
Switch
Events
- (Deprecated) List Eventsget
- List Eventsget

Network Health

Network Health
- Get data for all sitesget

New Device Inventory

Devices
Private Cloud Devices
- Get device from device inventoryget
MSP Devices

New Licensing

Subscriptions
Auto-License

Notification

Types
- List Typesget
Settings
Notification

Presence Analytics

Config
Associated
- Get details of connected and non connected visitors.get
Loyalty
PresenceStats
License
Insights

RAPIDS

Rogues
WIDS

Refresh API Token

refresh_api_token
- Refresh API tokenpost

Reporting

Reports
SDWAN Reports
- SDWAN DPS policy compliance reportget

SSO Configuration

SSO Support

Service Airgroup

Aruba airgroup

Service Airmatch

Aruba airmatch

Service IDS IPS

Aruba ids ips

Service IPMS

Aruba ipms

Service Overlay Wlan

Aruba overlay wlan

Service RAPIDS

Aruba Rapids

Service SDWAN

Branch Mesh
Hub Configuration
DC Preference
Microbranch Data-Center
Global Settings
Network Segments
Route Policy
Branch Aggregates
Tunnel Policy
Hub Mesh
Group Configuration
- Retrieve SDWAN global/group configurationget
- Delete SDWAN global/group configurationdelete
aruba_sdwan
- Retrieve node_list by identifier node-type node-idget

Service UCC

Aruba ucc

Topology

Topology

Troubleshooting

Troubleshooting
Action Command
- Action command for enroll est certificatepost

User Management

Users
Bulk Users
Roles

Vgw

Get Cloud Accounts
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-iddelete

VisualRF

GeoFence
Client Location
- Get location of a specific clientget
- Get a specific floor and location of all its clientsget
Rogue Location
- Get location of a specific rogue access pointget
- Get a specific floor and location of all its rogue access pointsget
Floorplan
Import
- create floorplans using zip file (supported files are zip and .esx)post
- get last import operation informationget
Anonymization

Webhook

Webhooks

ACP Audit Trail

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

ACP OFC Api Handler

Flowhandler

AIOps

Wi-Fi Connectivity Dashboard
AI Insights List
AI Insight Details

AirGroup

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

AirMatch

Radio
AP
Telemetry
- Bootstrappost
- Purgepost
Solution
Miscellaneous
Schedule
Radio feasibility
Deployer
RF domain
- Get partition informationget
- Start partition processpost

AppRF

Overview
- (Deprecated) Gets Top N Apprf Statisticsget
- Gets Top N Apprf Statistics (V2 Version)get
Applications
- Gets Top N Applicationsget
Web Categories
- Gets Top N Web categoriesget
App Categories
- Gets Top N App categoriesget
Web Reputations
- Gets Top Web Reputationsget
AppRF IAP Meta Info

Audit Event Logs

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

Authentication & Policy

Authentications and Sessions
Client Policy
Client Registration
Wi-Fi Easy Connect
User Policy
Download
- Fetch all Named MPSK as a CSV file.get
- Fetch all Mac Registrations as a CSV file.get
MPSK Networks Configs
File Upload
MAC Registration
User Management
- Fetches certificate details of a userget
- Revoke a user's device certificatepost

Ble Beacon Service

BleBeaconService

Client Match

Status
Unsteerable

Cloud Connect

Cloud Connect

Configuration

Groups
Pre Provisioned Group
- Pre Provision a group to the devicepost
- Assign Pre-Provisioned Grouppost
Templates
Configuration backup and restore
Devices
Variables
MM-MD
- Trigger Mobility Device recovery by resetting (delete and add) Device configuration.post
Certificates
Captive portal logo
MSP Templates
Configuration Mode
Variables firewall
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
denylist clients
WLAN Configuration
AP Settings
AP Configuration
Swarm Config
AOS-S

DPS Monitoring

Deprecated Device Inventory

Devices
Private Cloud Devices
- Get device from device inventoryget

Deprecated Licensing

Subscriptions
Auto-License

Device Management

ActionCommand
DMS

Device Replacement

Offline Devices
- Get all offline devicesget
Request Replacement
- To request device replacementpost
Check Compliance
- To check compliancepost
Initiate Replacement
- To initiate device replacementpost
Cancel Replacement
- To cancel device replacementpost
Devices Under Replacement
- To get devices under replacementget
Device status
- To check device statusget
Device count
- To get device count for a Tenant/Standalone accountget
MSP Replacement Count
- Count of devices under replacement for a MSP customerget
Get MSP customers
- Get all tenants under that MSP accountget
MSP replacement details
- Get replacement details of all tenants under that MSP accountget

Device Routing - BGP

Neighbor
Route
- List BGP routesget

Device Routing - OSPF

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

Device Routing - Overlay

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

Device Routing - RIP

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

Device Routing - RouteTable

Route
- Get routesget
- Get legacy routesget

Firmware

Firmware Management

GDPR

GDPR

Guest

Portals
Visitors
Sessions
- Get all sessions of a ssidget
Wlans
- Get all guest wlansget
Troubleshoot
- Check if guest is enabled for current user.get
- Provision cloud guest for current customerpost
WiFi4EU
- WiFi4EU Statuspost
Summary
- Get summary statisticsget

Install Manager

Installer
QR code
Sites

IoT - App Developer Portal

Apps
Container Image

IoT - Appstore

App Store

IoT - Device

Devices

IoT - Iotgateway

iot_gateways
association
groups

IoT - Transport Profile

Transport Profile

MSP

Customers
Get Country Code
- Get list of country codeget
Users
- Get list of users under the MSP account based on limit and offsetget
- Get list of users under the Customer account based on limit and offsetget
Resources
- Get the resource under the MSPget
- Edit an existing resource for the MSPput
Devices
Groups
- Get list of customers mapped to MSP group based on limit and offset.get

Monitoring

Network
AP
Swarm
Client
VPN
- Vpn Detailsget
- Swarm VPN statspost
MobilityController
Gateway
Label
Site
Switch
Events
- (Deprecated) List Eventsget
- List Eventsget

Network Health

Network Health
- Get data for all sitesget

New Device Inventory

Devices
Private Cloud Devices
- Get device from device inventoryget
MSP Devices

New Licensing

Subscriptions
Auto-License

Notification

Types
- List Typesget
Settings
Notification

Presence Analytics

Config
Associated
- Get details of connected and non connected visitors.get
Loyalty
PresenceStats
License
Insights

RAPIDS

Rogues
WIDS

Refresh API Token

refresh_api_token
- Refresh API tokenpost

Reporting

Reports
SDWAN Reports
- SDWAN DPS policy compliance reportget

SSO Configuration

SSO Support

Service Airgroup

Aruba airgroup

Service Airmatch

Aruba airmatch

Service IDS IPS

Aruba ids ips

Service IPMS

Aruba ipms

Service Overlay Wlan

Aruba overlay wlan

Service RAPIDS

Aruba Rapids

Service SDWAN

Branch Mesh
Hub Configuration
DC Preference
Microbranch Data-Center
Global Settings
Network Segments
Route Policy
Branch Aggregates
Tunnel Policy
Hub Mesh
Group Configuration
- Retrieve SDWAN global/group configurationget
- Delete SDWAN global/group configurationdelete
aruba_sdwan
- Retrieve node_list by identifier node-type node-idget

Service UCC

Aruba ucc

Topology

Topology

Troubleshooting

Troubleshooting
Action Command
- Action command for enroll est certificatepost

User Management

Users
Bulk Users
Roles

Vgw

Get Cloud Accounts
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-iddelete

VisualRF

GeoFence
Client Location
- Get location of a specific clientget
- Get a specific floor and location of all its clientsget
Rogue Location
- Get location of a specific rogue access pointget
- Get a specific floor and location of all its rogue access pointsget
Floorplan
Import
- create floorplans using zip file (supported files are zip and .esx)post
- get last import operation informationget
Anonymization

Webhook

Webhooks

Create General settings for given Global or Group

post https://{api-base-url}/airgroup-config/v2/node_list/{node_type}/{node_id}/config/general_settings/

AirGroup generic settings

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

node_type

string

required

Defines the type of configuration node to which the config is being applied.

node_id

string

required

The identifier of the configuration node(aka group). For node-type GLOBAL, node-id should be 'GLOBAL'. For node-type 'GROUP', node-id should be set to the group-name

Body Params

JSON representation of general_settings config

airgroup_status

boolean

Defaults to false

Specifies if AirGroup service is enabled/disabled. This over-rides enable/disable at individual service level

inherited_from

string

This field indicates whether this profile was explicitly configured at this node or inherited from a parent node

Responses

Response body

object

status

string

Status of API execution

license_warning

string

Optional message that conveys licensing requirement for applying the config via this API

deprecation_warning

string

Warning message in case some or all of the config being applied is deprecated

Response body

object

status

string

Status of API execution

license_warning

string

Optional message that conveys licensing requirement for applying the config via this API

deprecation_warning

string

Warning message in case some or all of the config being applied is deprecated

Response body

object

Error-Message

string

Brief message that categorizes the error

Error-Details

string

Message providing more details and specifics of the error

Error-Code

integer

Integer error code

401

Unauthorized

403

Forbidden

Response body

object

Error-Message

string

Brief message that categorizes the error

Error-Details

string

Message providing more details and specifics of the error

Error-Code

integer

Integer error code

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Response body

object

Error-Message

string

Brief message that categorizes the error

Error-Details

string

Message providing more details and specifics of the error

Error-Code

integer

Integer error code

Response body

object

Error-Message

string

Brief message that categorizes the error

Error-Details

string

Message providing more details and specifics of the error

Error-Code

integer

Integer error code

Updated 11 months ago

Create/Update General settings for given Global or Group

Delete General settings for given Global or Group

Did this page help you?

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-base-url/airgroup-config/v2/node_list/GLOBAL/node_id/config/general_settings/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "airgroup_status": false
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 11 months ago

Create/Update General settings for given Global or Group

Delete General settings for given Global or Group

Did this page help you?

ACP Audit Trail
audit
Get details of an audit logget
Get all audit logsget

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

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

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

AirMatch
Radio
Get radio neighbor listget
Get board limits of a specific radio MACget
Get EIRP reasonsget
Get all radar and noise RF events of a tenantget
Get all RF events of a tenant idget
Get neighbor stats informationget
Get information about radioget
Get EIRP reasonsget
Get EIRP distributionget
Get all static radios for a customerget
Get all nbr pathloss for a customer and radio MACget
Get history of a specific radio MACget
Get radar and noise RF events of a specific radio MACget
Get RF events of a specific radio MACget
Get all nbr pathloss for a customer and bandget
Get nbr pathloss of a neighbor MAC heard by a specific radio MACget
Get all reporting radio for a customerget
Get reporting radio of a specific radio MACget
AP
Get AP neighbor listget
Get AP neighbor listget
Get feasibility ap info of a specific AP ethernet MACget
Returns all device (AP) running configuration for a customerget
Change a device running configput
Returns device (AP) running configurationget
Change a device running configput
Returns device (AP) running configurationget
Returns all device (AP) running configuration for a customerget
Get number of AP's and AP modelsget
Get AP info for all AP'sget
Get AP info of a specific AP ethernet MACget
Telemetry
Purgepost
Bootstrappost
Solution
Get optimizations for tenant's requested partitionget
Get all solutions for a customerget
Get solution of a specific radio MACget
Run the algorithm for the solutionpost
Get optimizations for tenantget
Miscellaneous
Returns device (AP) running configurationget
Returns all device (AP) running configuration for all customersget
Gets radios deployment statusget
Schedule
Trigger - RMQ message with on-demand compute for a provided tenant idpost
Get the list of unique timezone and deploy hours per tenantget
Get the list of jobs generated by schedulerget
Get the jobs to be sent to deployer for AirMatch solution deploymentget
Get the schedule of all jobs computed by the schedulerget
RMQ message triggers a runnow job for a certain tenantpost
RMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour detailspost
Radio feasibility
Get feasibility radio info of a specific radio MACget
Get all radio feasibility for a customerget
Get radio_feasibility of a specific radio MACget
Get all radio feasibility for a customerget
Get radio feasibility of a specific radio MACget
Trigger update of radio feasibilityput
Deployer
Trigger test-config updatepost
RMQ message generates southbound test action-msgpost
Trigger computation complete messagepost
Get a list of pending deployments for a tenant idget
RF domain
Start partition processpost
Get partition informationget

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

Audit Event Logs
audit
Get details of an audit event/logget
Get all audit events for all groupsget

Authentication & Policy
Authentications and Sessions
Fetch list of sessions using Cloud Identity.get
Fetch list of sessions using Aruba Air Pass.get
Fetch details of a specific authentication using either Cloud Identity or Aruba Air Pass.get
Fetch list of authentications using Cloud Identity.get
Fetch list of authentications using Aruba Air Pass.get
Client Policy
Reset Client Policy.put
Delete existing Client Policy.delete
Configure or update network access policy for registered clients.put
Fetch network access policy for registered clients.get
Client Registration
Update registered client name.patch
Delete registered client.delete
Add registered client.post
Fetch list of registered clients.get
Wi-Fi Easy Connect
Delete registered client.delete
Update registered client with bootstrapping key.put
Register a client.post
Fetch list of registered clients.get
User Policy
Reset User Policy.put
Delete existing User Policy.delete
Configure policy to allow wireless network access for users.put
Fetch policy that allows wireless network access for users.get
Download
Fetch all Mac Registrations as a CSV file.get
Fetch all Named MPSK as a CSV file.get
MPSK Networks Configs
Read MPSK Usage Statsget
Partially Edit a Named MPSK Configpatch
Delete a Named MPSK Configdelete
Edit a Named MPSK Configput
Read a named MPSK configget
Add a named MPSK configpost
Read all named MPSKget
Delete an MPSK network configuration.delete
Edit an MPSK network configput
Read one MPSK network config.get
Create an MPSK network configpost
Read all configured MPSK networks.get
File Upload
Terminate Uploadput
Read upload status of last file uploadget
Read errors in last file uploadget
Upload filepost
Terminate Uploadput
Read upload status of last file uploadget
Read errors in last file uploadget
Upload filepost
MAC Registration
Update registered client name.patch
Delete registered mac registration.delete
Add mac registration.post
Fetch list of mac registrations.get
User Management
Revoke a user's device certificatepost
Fetches certificate details of a userget

Ble Beacon Service
BleBeaconService
Delete one device beacon configdelete
Update one device beacon configpost
Delete ble beacon profiledelete
Edit ble beacon profilepost
Config ble beacon profilepost
Retrieve ble beacon profilesget
Retrieve ble running beaconsget
Retrieve ble configured beaconsget

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

Cloud Connect
Cloud Connect
Delete Prisma Cloud Account with name as account_namedelete
Creates a new Prisma Cloud Account with name as account_namepost
Updates an existing Prisma Cloud Account with name as account_nameput
Get the Prisma Account Configuration for account_nameget
Delete Custom Cloud Account with name as account_namedelete
Creates a new Custom Cloud Account with name as account_namepost
Updates an existing Custom Cloud Account with name as account_nameput
Get the Custom Cloud Account Configuration for account_nameget
Delete Tunnel Policy with name as policy_namedelete
Creates a new Tunnel Policy with name as policy_namepost
Updates an existing Tunnel Policy with name as policy_nameput
Get the Tunnel Policy Configuration for policy_nameget
Get the list of all Tunnel Policy Configurationsget
Get the list of valid Tunnel Policy configurationsget
Get config summary for configured groups.get
Get configured vlan list for each cloud connect endpoint.get
Get Zscaler node scan details.get
Get all Cloud Provider endpoints.get
Trigger cloud provider endpoint scan.get
Delete Prisma cloud provider endpoint configdelete
Create Prisma cloud provider endpoint configpost
Update Prisma cloud provider endpoint configput
Delete Azure cloud provider endpoint configdelete
Create Azure cloud provider endpoint configpost
Update Azure cloud provider endpoint configput
Delete AWS cloud provider endpoint configdelete
Create AWS cloud provider endpoint configpost
Update AWS cloud provider endpoint configput
Delete Zscaler cloud provider endpoint configdelete
Create Zscaler cloud provider endpoint configpost
Update Zscaler cloud provider endpoint configput
Delete Custom cloud provider endpoint configdelete
Create Custom cloud provider endpoint configpost
Update Custom cloud provider endpoint configput

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

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

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

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

Device Management
ActionCommand
Statusget
Speed Testpost
Disconnect Userpost
Generic commands for swarmpost
Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
Generic commands for devicepost
DMS
Delete Mobility Master to Mobility Device mappingdelete
Get assigned Mobility Master to Mobility Device.get
Statically assign Mobility Master to Mobility Device.post

Device Replacement
Offline Devices
Get all offline devicesget
Request Replacement
To request device replacementpost
Check Compliance
To check compliancepost
Initiate Replacement
To initiate device replacementpost
Cancel Replacement
To cancel device replacementpost
Devices Under Replacement
To get devices under replacementget
Device status
To check device statusget
Device count
To get device count for a Tenant/Standalone accountget
MSP Replacement Count
Count of devices under replacement for a MSP customerget
Get MSP customers
Get all tenants under that MSP accountget
MSP replacement details
Get replacement details of all tenants under that MSP accountget

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

Device Routing - OSPF
Area
List OSPF Area Informationget
Interface
List OSPF Interface Informationget
Neighbor
List OSPF neighbor Informationget
LinkStateDatabase
List OSPF Link State Database Informationget

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

Device Routing - RIP
Interface
List RIP interfacesget
Neighbor
List of routes learned from a RIP neighborget
List RIP neighborsget
Route
List RIP routesget

Device Routing - RouteTable
Route
Get legacy routesget
Get routesget

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

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

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

Install Manager
Installer
Update an installerpatch
Delete an installerdelete
Get all installersget
Invite a new installerpost
QR code
Update a QR codepatch
Delete a QR codedelete
Create a QR codepost
Get QR code listget
Sites
Update site statuspatch
Get all assigned group to sites listget
For a given set of site names, assign Group Names for each device typepost

IoT - App Developer Portal
Apps
List App Versionsget
Submit Apppost
Get App Version Detailsget
Withdraw App Versionpost
Delete App Versiondelete
Validate App Nameget
Edit Draft Apppost
Create Apppost
List Draft Appsget
List Published and Suspended Appsget
Container Image
Validate Image Nameget
List Images For Max Versionget
Upload Imagepost
List Imagesget

IoT - Appstore
App Store
Find Recommended Appsget
Developer infoget
Upgrade developer apppost
Get the last 10 versions of an Appget
Delete Developer appdelete
Install Developer apppost
Get Developer App Iconget
Get Developer Appget
Edit Developer installed app configurationpost
Developer appsget
Upgrade apppost
Delete appdelete
Edit Installed app configurationpost
Install apppost
Get App Iconget
Get Appget
Count all installed appsget
Find all installed appsget
Search appsget

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

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

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

MSP
Customers
Delete a customerdelete
(Deprecated) Update a customerput
Get details of customerget
Update a customerput
Create a new customerpost
(Deprecated) Create a new customerpost
Get list of customers under the MSP account based on limit and offsetget
Get Country Code
Get list of country codeget
Users
Get list of users under the Customer account based on limit and offsetget
Get list of users under the MSP account based on limit and offsetget
Resources
Edit an existing resource for the MSPput
Get the resource under the MSPget
Devices
Get list of devices and licenses under the MSP account based on limit and offset, offset should be a multiple of the limit valueget
Un-assign all devices from Tenant/end-customer.put
Move a device to an end-customerput
Get list of devices and licenses under the Customer account based on limit and offset, offset should be a multiple of the limit valueget
Groups
Get list of customers mapped to MSP group based on limit and offset.get

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

Network Health
Network Health
Get data for all sitesget

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

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

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

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

RAPIDS
Rogues
List manually contained APsget
List neighbor APsget
List suspect APsget
List Interfering APsget
List Rogue APsget
WIDS
WIDS Eventsget
List Client Attacksget
List Infrastructure Attacksget

Refresh API Token
refresh_api_token
Refresh API tokenpost

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

SSO Configuration
SSO Support
Extract Saml metadata from filepost
Un-claim domaindelete
Add IDP configpost
Update IDP configurationput
Get domain listget
Get saml metadataget

Service Airgroup
Aruba airgroup
Retrieve node_list by identifier node-type node-idget
Delete complete Airgroup config for given Global or Groupdelete
Retrieve complete Airgroup config for given Global or Groupget
Retrieve all airgroup service policies at given Global or groupget
Delete airgroup service policy by name at Global or groupdelete
Create airgroup service policy by name at Global or grouppost
Create/Update airgroup service policy by name at Global or groupput
Retrieve airgroup service policy by name at Global or groupget
Delete role restrictions for given service at global or groupdelete
Create role restrictions for given service at global or grouppost
Create/Update role restrictions for given service at global or groupput
Retrieve role restrictions for given service at global or groupget
Retrieve all allowed roles for given serviceget
Delete allowed role for given servicedelete
Create allowed role for given servicepost
Create/Update allowed role for given serviceput
Retrieve allowed role for given serviceget
Retrieve all disallowed roles for given serviceget
Delete disallowed role for given servicedelete
Create disallowed role for given servicepost
Create/Update disallowed role for given serviceput
Retrieve disallowed role for given serviceget
Delete vlan restriction for given service at Global or groupdelete
Create vlan restriction for given service at Global or grouppost
Create/Update vlan restriction for given service at Global or groupput
Retrieve vlan restriction for given service at Global or groupget
Retrieve all allowed vlans for given serviceget
Delete allowed vlan for given servicedelete
Create allowed vlan for given servicepost
Create/Update allowed vlan for given serviceput
Retrieve allowed vlan for given serviceget
Retrieve all disallowed vlans for given serviceget
Delete disallowed vlan for given servicedelete
Create disallowed vlan for given servicepost
Create/Update disallowed vlan for given serviceput
Retrieve disallowed vlan for given serviceget
Delete General settings for given Global or Groupdelete
Create General settings for given Global or Grouppost
Create/Update General settings for given Global or Groupput
Retrieve General settings for given Global or Groupget
Delete airgroup_statusdelete
Create airgroup_statuspost
Create/Update airgroup_statusput
Retrieve airgroup_statusget
Retrieve all configured airgroup serversget
Delete airgroup server config by mac_addressdelete
Create airgroup server config by mac_addresspost
Create/Update airgroup server config by mac_addressput
Retrieve airgroup server config by mac_addressget
Delete network visibility config for given airgroup serverdelete
Create network visibility config for given airgroup serverpost
Create/Update network visibility config for given airgroup serverput
Retrieve network visibility config for given airgroup serverget
Retrieve complete visibility ap_list for given serverget
Delete entry for serial_number in visibility ap_list for given serverdelete
Create entry for serial_number in visibility ap_list for given serverpost
Create/Update entry for serial_number in visibility ap_list for given serverput
Retrieve entry for serial_number in visibility ap_list for given serverget
Delete role restrictions for given airgroup serverdelete
Create role restrictions for given airgroup serverpost
Create/Update role restrictions for given airgroup serverput
Retrieve role restrictions for given airgroup serverget
Retrieve all allowed roles for given serverget
Delete allowed role for given serverdelete
Create allowed role for given serverpost
Create/Update allowed role for given serverput
Retrieve allowed role for given serverget
Retrieve all disallowed roles for given serverget
Delete disallowed role for given serverdelete
Create disallowed role for given serverpost
Create/Update disallowed role for given serverput
Retrieve disallowed role for given serverget
Retrieve common_configget
Retrieve all standard Airgroup service definitionsget
Create standard service for given namepost
Create/Update standard service for given nameput
Retrieve standard service for given nameget
Retrieve all service-ids for given standard serviceget
Create service-id mapping for given standard servicepost
Create/Update service-id mapping for given standard serviceput
Retrieve service-id mapping for given standard serviceget
Delete Personal device visibility configurationdelete
Create Personal device visibility configurationpost
Create/Update Personal device visibility configurationput
Retrieve Personal device visibility configurationget
Retrieve all user-ids treated as admin users for device visibilityget
Delete entry in admin user-ids for given user_iddelete
Create entry in admin user-ids for given user_idpost
Create/Update entry in admin user-ids for given user_idput
Retrieve entry in admin user-ids for given user_idget
Retrieve all custom service definitionsget
Delete custom service for given namedelete
Create custom service for given namepost
Create/Update custom service for given nameput
Retrieve custom service for given nameget
Retrieve all service-ids in given custom serviceget
Delete service-id for given custom servicedelete
Create service-id for given custom servicepost
Create/Update service-id for given custom serviceput
Retrieve service-id for given custom serviceget

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

Service IDS IPS
Aruba ids ips
Retrieve node_list by identifier node-type node-idget
Delete complete config for IDS/IPSdelete
Create complete config for IDS/IPSpost
Create/Update complete config for IDS/IPSput
Retrieve complete config for IDS/IPSget
Retrieve config for all SIEM serversget
Delete SIEM server config for given siem_server_namedelete
Create SIEM server config for given siem_server_namepost
Create/Update SIEM server config for given siem_server_nameput
Retrieve SIEM server config for given siem_server_nameget
Delete SIEM server notification configurationdelete
Create SIEM server notification configurationpost
Create/Update SIEM server notification configurationput
Retrieve SIEM server notification configurationget

Service IPMS
Aruba ipms
Retrieve node_list by identifier node-type node-idget
Retrieve complete IPMS configget
Retrieve all IP address poolsget
Delete IP address pool for given pool_namedelete
Create IP address pool for given pool_namepost
Create/Update IP address pool for given pool_nameput
Retrieve IP address pool for given pool_nameget
Retrieve all IP ranges for given address pool_nameget
Create IP range by range_id for given address pool_namepost
Create/Update IP range by range_id for given address pool_nameput
Retrieve IP range by range_id for given address pool_nameget

Service Overlay Wlan
Aruba overlay wlan
Retrieve node_list by identifier node-type node-idget
Delete Complete Overlay-wlan config for given groupdelete
Create Complete Overlay-wlan config for given grouppost
Create/Update Complete Overlay-wlan config for given groupput
Retrieve Complete Overlay-wlan config for given groupget
Retrieve all Profile to Cluster mappings for given groupget
Delete Cluster mapping for given profile and profile_typedelete
Create Cluster mapping for given profile and profile_typepost
Create/Update Cluster mapping for given profile and profile_typeput
Retrieve Cluster mapping for given profile and profile_typeget
Retrieve all Cluster mappings for given profile and typeget
Delete Cluster mapping by redundancy-type and group-name for given profile and typedelete
Create Cluster mapping by redundancy-type and group-name for given profile and typepost
Create/Update Cluster mapping by redundancy-type and group-name for given profile and typeput
Retrieve Cluster mapping by redundancy-type and group-name for given profile and typeget

Service RAPIDS
Aruba Rapids
Retrieve node_list by identifier node-type node-idget
Delete complete RAPIDS configurationdelete
Create complete RAPIDS configurationpost
Create/Update complete RAPIDS configurationput
Retrieve complete RAPIDS configurationget
Retrieve all Classification rulesget
Delete Classification rule by rule_namedelete
Create Classification rule by rule_namepost
Create/Update Classification rule by rule_nameput
Retrieve Classification rule by rule_nameget
Delete match criteria for given classification rule_namedelete
Create match criteria for given classification rule_namepost
Create/Update match criteria for given classification rule_nameput
Retrieve match criteria for given classification rule_nameget
Retrieve all sites in Site-Excludes for given classification rule_nameget
Delete site by name in Site-Excludes for given classification rule_namedelete
Create site by name in Site-Excludes for given classification rule_namepost
Create/Update site by name in Site-Excludes for given classification rule_nameput
Retrieve site by name in Site-Excludes for given classification rule_nameget
Retrieve all sites in Site-Includes for given classification rule_nameget
Delete site by name in Site-Includes for given classification rule_namedelete
Create site by name in Site-Includes for given classification rule_namepost
Create/Update site by name in Site-Includes for given classification rule_nameput
Retrieve site by name in Site-Includes for given classification rule_nameget
Retrieve all exclude SSIDs for given classification rule_nameget
Delete essid in exclude SSIDs for given classification rule_namedelete
Create essid in exclude SSIDs for given classification rule_namepost
Create/Update essid in exclude SSIDs for given classification rule_nameput
Retrieve essid in exclude SSIDs for given classification rule_nameget
Retrieve all include SSIDs for given classification rule_nameget
Delete essid in include SSIDs for given classification rule_namedelete
Create essid in include SSIDs for given classification rule_namepost
Create/Update essid in include SSIDs for given classification rule_nameput
Retrieve essid in include SSIDs for given classification rule_nameget

Service SDWAN
Branch Mesh
Retrieve branch-mesh config for all labelsget
Retrieve branch-mesh by labelget
Delete branch-mesh config for given labeldelete
Create branch-mesh config for given labelpost
Create/Update branch-mesh config for given labelput
Retrieve branch-mesh config for given labelget
Retrieve all branch-devices for given branch-mesh labelget
Delete branch-devices by device serial numberdelete
Create branch-devices by device serial numberpost
Create/Update branch-devices by device serial numberput
Retrieve branch-devices by device serial numberget
Hub Configuration
Delete global hub configurationdelete
Retrieve global hub configurationget
Retrieve DC aggregate routes for all network segmentsget
Delete DC aggregate routes for given network segmentdelete
Create DC aggregate routes for given network segmentpost
Create/Update DC aggregate routes for given network segmentput
Retrieve DC aggregate routes for given network segmentget
Retrieve all DC aggregate route prefixes for given network segmentget
Delete DC aggregate routes by prefix for given network segmentdelete
Create DC aggregate routes by prefix for given network segmentpost
Create/Update DC aggregate routes by prefix for given network segmentput
Retrieve DC aggregate routes by prefix for given network segmentget
Delete transitdelete
Create transitpost
Create/Update transitput
Retrieve transitget
DC Preference
Delete branch/micro-branch configurationdelete
Create branch/micro-branch configurationpost
Create/Update branch/micro-branch configurationput
Retrieve branch/micro-branch configurationget
Retrieve all hubs-clusters for given branch groupget
Delete hub-clusters by cluster name and cluster groupdelete
Create hub-clusters by cluster name and cluster grouppost
Create/Update hub-clusters by cluster name and cluster groupput
Retrieve hub-clusters by cluster name and cluster groupget
Retrieve all hub devices for given branch groupget
Delete hubs by device serial numberdelete
Retrieve hubs by device serial numberget
Microbranch Data-Center
Delete microbranch-dc-clusterdelete
Create microbranch-dc-clusterpost
Create/Update microbranch-dc-clusterput
Retrieve microbranch-dc-clusterget
Retrieve hub-clustersget
Delete hub-clusters by identifier cluster-name cluster-groupdelete
Create hub-clusters by identifier cluster-name cluster-grouppost
Create/Update hub-clusters by identifier cluster-name cluster-groupput
Retrieve hub-clusters by identifier cluster-name cluster-groupget
Global Settings
Delete sdwan-globaldelete
Retrieve sdwan-globalget
Delete topologydelete
Create topologypost
Create/Update topologyput
Retrieve topologyget
Delete admin-statusdelete
Create admin-statuspost
Create/Update admin-statusput
Retrieve admin-statusget
Network Segments
Retrieve network-segment-policy config for all segmentsget
Delete network-segment-policy by segment namedelete
Create network-segment-policy by segment namepost
Create/Update network-segment-policy by segment nameput
Retrieve network-segment-policy by segment nameget
Route Policy
Delete route-policydelete
Retrieve route-policyget
Delete global load-balance orchestration configurationdelete
Create global load-balance orchestration configurationpost
Create/Update global load-balance orchestration configurationput
Retrieve global load-balance orchestration configurationget
Delete global hub route policy configurationdelete
Create global hub route policy configurationpost
Create/Update global hub route policy configurationput
Retrieve global hub route policy configurationget
Delete best-path-computationdelete
Create best-path-computationpost
Create/Update best-path-computationput
Retrieve best-path-computationget
Delete global graceful restart timer configurationdelete
Create global graceful restart timer configurationpost
Create/Update global graceful restart timer configurationput
Retrieve global graceful restart timer configurationget
Delete timerdelete
Create timerpost
Create/Update timerput
Retrieve timerget
Delete as-numberdelete
Create as-numberpost
Create/Update as-numberput
Retrieve as-numberget
Branch Aggregates
Retrieve branch-aggregate prefixes for all segmentsget
Delete global branch aggregate routes for given network segmentdelete
Create global branch aggregate routes for given network segmentpost
Create/Update global branch aggregate routes for given network segmentput
Retrieve global branch aggregate routes for given network segmentget
Retrieve all branch-aggregate prefixes for given segmentget
Delete global branch aggregate routes by prefix for given network segmentdelete
Create global branch aggregate routes by prefix for given network segmentpost
Create/Update global branch aggregate routes by prefix for given network segmentput
Retrieve global branch aggregate routes by prefix for given network segmentget
Tunnel Policy
Delete tunnel-policydelete
Create tunnel-policypost
Create/Update tunnel-policyput
Retrieve tunnel-policyget
Delete rekey-intervaldelete
Create rekey-intervalpost
Create/Update rekey-intervalput
Retrieve rekey-intervalget
Hub Mesh
Delete mesh-policydelete
Retrieve mesh-policyget
Retrieve hub-mesh config for all labelsget
Delete hub-mesh by labeldelete
Create hub-mesh by labelpost
Create/Update hub-mesh by labelput
Retrieve hub-mesh by labelget
Retrieve all hub-groups for given hub-mesh labelget
Delete hub-groups by namedelete
Create hub-groups by namepost
Create/Update hub-groups by nameput
Retrieve hub-groups by nameget
Group Configuration
Delete SDWAN global/group configurationdelete
Retrieve SDWAN global/group configurationget
aruba_sdwan
Retrieve node_list by identifier node-type node-idget

Service UCC
Aruba ucc
Retrieve node_list by identifier node-type node-idget
Delete complete UCC configdelete
Create complete UCC configpost
Create/Update complete UCC configput
Retrieve complete UCC configget
Delete UCC settingsdelete
Create UCC settingspost
Create/Update UCC settingsput
Retrieve UCC settingsget
Delete activatedelete
Create activatepost
Create/Update activateput
Retrieve activateget
Delete ucc_algdelete
Create ucc_algpost
Create/Update ucc_algput
Retrieve ucc_algget
Delete DSCP Priority configuration for Zoomdelete
Create DSCP Priority configuration for Zoompost
Create/Update DSCP Priority configuration for Zoomput
Retrieve DSCP Priority configuration for Zoomget
Delete DSCP Priority configuration for MS Teamsdelete
Create DSCP Priority configuration for MS Teamspost
Create/Update DSCP Priority configuration for MS Teamsput
Retrieve DSCP Priority configuration for MS Teamsget
Delete DSCP Priority configuration for SIP ALGdelete
Create DSCP Priority configuration for SIP ALGpost
Create/Update DSCP Priority configuration for SIP ALGput
Retrieve DSCP Priority configuration for SIP ALGget
Delete DSCP Priority configuration for Wifi Callingdelete
Create DSCP Priority configuration for Wifi Callingpost
Create/Update DSCP Priority configuration for Wifi Callingput
Retrieve DSCP Priority configuration for Wifi Callingget
Retrieve all configured DNS patternsget
Delete 'dns_patterns' config for given dns_patterndelete
Create 'dns_patterns' config for given dns_patternpost
Create/Update 'dns_patterns' config for given dns_patternput
Retrieve 'dns_patterns' config for given dns_patternget
Delete DSCP Priority configuration for 'Skype for Business'delete
Create DSCP Priority configuration for 'Skype for Business'post
Create/Update DSCP Priority configuration for 'Skype for Business'put
Retrieve DSCP Priority configuration for 'Skype for Business'get

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

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

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

Vgw
Get Cloud Accounts
Configure Cloud account for provider Zscalerget
Configure Cloud account for provider Azureget
Configure Cloud account for provider AWSget
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-iddelete

VisualRF
GeoFence
Disable geofencedelete
Enable geofencepost
Get status of geofenceget
Client Location
Get a specific floor and location of all its clientsget
Get location of a specific clientget
Rogue Location
Get a specific floor and location of all its rogue access pointsget
Get location of a specific rogue access pointget
Floorplan
Get location of a specific access pointget
Get a specific floor and location of all its access pointsget
Get background image of a specific floorget
Get details of a specific floorget
Get a specific building and its floorsget
Get a specific campus and its buildingsget
Get list of all campusesget
Import
get last import operation informationget
create floorplans using zip file (supported files are zip and .esx)post
Anonymization
Disable anonymizationdelete
Enable anonymizationpost
Get status of anonymizationget

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

ACP Audit Trail
audit
Get details of an audit logget
Get all audit logsget

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

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

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

AirMatch
Radio
Get radio neighbor listget
Get board limits of a specific radio MACget
Get EIRP reasonsget
Get all radar and noise RF events of a tenantget
Get all RF events of a tenant idget
Get neighbor stats informationget
Get information about radioget
Get EIRP reasonsget
Get EIRP distributionget
Get all static radios for a customerget
Get all nbr pathloss for a customer and radio MACget
Get history of a specific radio MACget
Get radar and noise RF events of a specific radio MACget
Get RF events of a specific radio MACget
Get all nbr pathloss for a customer and bandget
Get nbr pathloss of a neighbor MAC heard by a specific radio MACget
Get all reporting radio for a customerget
Get reporting radio of a specific radio MACget
AP
Get AP neighbor listget
Get AP neighbor listget
Get feasibility ap info of a specific AP ethernet MACget
Returns all device (AP) running configuration for a customerget
Change a device running configput
Returns device (AP) running configurationget
Change a device running configput
Returns device (AP) running configurationget
Returns all device (AP) running configuration for a customerget
Get number of AP's and AP modelsget
Get AP info for all AP'sget
Get AP info of a specific AP ethernet MACget
Telemetry
Purgepost
Bootstrappost
Solution
Get optimizations for tenant's requested partitionget
Get all solutions for a customerget
Get solution of a specific radio MACget
Run the algorithm for the solutionpost
Get optimizations for tenantget
Miscellaneous
Returns device (AP) running configurationget
Returns all device (AP) running configuration for all customersget
Gets radios deployment statusget
Schedule
Trigger - RMQ message with on-demand compute for a provided tenant idpost
Get the list of unique timezone and deploy hours per tenantget
Get the list of jobs generated by schedulerget
Get the jobs to be sent to deployer for AirMatch solution deploymentget
Get the schedule of all jobs computed by the schedulerget
RMQ message triggers a runnow job for a certain tenantpost
RMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour detailspost
Radio feasibility
Get feasibility radio info of a specific radio MACget
Get all radio feasibility for a customerget
Get radio_feasibility of a specific radio MACget
Get all radio feasibility for a customerget
Get radio feasibility of a specific radio MACget
Trigger update of radio feasibilityput
Deployer
Trigger test-config updatepost
RMQ message generates southbound test action-msgpost
Trigger computation complete messagepost
Get a list of pending deployments for a tenant idget
RF domain
Start partition processpost
Get partition informationget

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

Audit Event Logs
audit
Get details of an audit event/logget
Get all audit events for all groupsget

Authentication & Policy
Authentications and Sessions
Fetch list of sessions using Cloud Identity.get
Fetch list of sessions using Aruba Air Pass.get
Fetch details of a specific authentication using either Cloud Identity or Aruba Air Pass.get
Fetch list of authentications using Cloud Identity.get
Fetch list of authentications using Aruba Air Pass.get
Client Policy
Reset Client Policy.put
Delete existing Client Policy.delete
Configure or update network access policy for registered clients.put
Fetch network access policy for registered clients.get
Client Registration
Update registered client name.patch
Delete registered client.delete
Add registered client.post
Fetch list of registered clients.get
Wi-Fi Easy Connect
Delete registered client.delete
Update registered client with bootstrapping key.put
Register a client.post
Fetch list of registered clients.get
User Policy
Reset User Policy.put
Delete existing User Policy.delete
Configure policy to allow wireless network access for users.put
Fetch policy that allows wireless network access for users.get
Download
Fetch all Mac Registrations as a CSV file.get
Fetch all Named MPSK as a CSV file.get
MPSK Networks Configs
Read MPSK Usage Statsget
Partially Edit a Named MPSK Configpatch
Delete a Named MPSK Configdelete
Edit a Named MPSK Configput
Read a named MPSK configget
Add a named MPSK configpost
Read all named MPSKget
Delete an MPSK network configuration.delete
Edit an MPSK network configput
Read one MPSK network config.get
Create an MPSK network configpost
Read all configured MPSK networks.get
File Upload
Terminate Uploadput
Read upload status of last file uploadget
Read errors in last file uploadget
Upload filepost
Terminate Uploadput
Read upload status of last file uploadget
Read errors in last file uploadget
Upload filepost
MAC Registration
Update registered client name.patch
Delete registered mac registration.delete
Add mac registration.post
Fetch list of mac registrations.get
User Management
Revoke a user's device certificatepost
Fetches certificate details of a userget

Ble Beacon Service
BleBeaconService
Delete one device beacon configdelete
Update one device beacon configpost
Delete ble beacon profiledelete
Edit ble beacon profilepost
Config ble beacon profilepost
Retrieve ble beacon profilesget
Retrieve ble running beaconsget
Retrieve ble configured beaconsget

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

Cloud Connect
Cloud Connect
Delete Prisma Cloud Account with name as account_namedelete
Creates a new Prisma Cloud Account with name as account_namepost
Updates an existing Prisma Cloud Account with name as account_nameput
Get the Prisma Account Configuration for account_nameget
Delete Custom Cloud Account with name as account_namedelete
Creates a new Custom Cloud Account with name as account_namepost
Updates an existing Custom Cloud Account with name as account_nameput
Get the Custom Cloud Account Configuration for account_nameget
Delete Tunnel Policy with name as policy_namedelete
Creates a new Tunnel Policy with name as policy_namepost
Updates an existing Tunnel Policy with name as policy_nameput
Get the Tunnel Policy Configuration for policy_nameget
Get the list of all Tunnel Policy Configurationsget
Get the list of valid Tunnel Policy configurationsget
Get config summary for configured groups.get
Get configured vlan list for each cloud connect endpoint.get
Get Zscaler node scan details.get
Get all Cloud Provider endpoints.get
Trigger cloud provider endpoint scan.get
Delete Prisma cloud provider endpoint configdelete
Create Prisma cloud provider endpoint configpost
Update Prisma cloud provider endpoint configput
Delete Azure cloud provider endpoint configdelete
Create Azure cloud provider endpoint configpost
Update Azure cloud provider endpoint configput
Delete AWS cloud provider endpoint configdelete
Create AWS cloud provider endpoint configpost
Update AWS cloud provider endpoint configput
Delete Zscaler cloud provider endpoint configdelete
Create Zscaler cloud provider endpoint configpost
Update Zscaler cloud provider endpoint configput
Delete Custom cloud provider endpoint configdelete
Create Custom cloud provider endpoint configpost
Update Custom cloud provider endpoint configput

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

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

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

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

Device Management
ActionCommand
Statusget
Speed Testpost
Disconnect Userpost
Generic commands for swarmpost
Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
Generic Action Command for bouncing interface or POE (power-over-ethernet) portpost
Generic commands for devicepost
DMS
Delete Mobility Master to Mobility Device mappingdelete
Get assigned Mobility Master to Mobility Device.get
Statically assign Mobility Master to Mobility Device.post

Device Replacement
Offline Devices
Get all offline devicesget
Request Replacement
To request device replacementpost
Check Compliance
To check compliancepost
Initiate Replacement
To initiate device replacementpost
Cancel Replacement
To cancel device replacementpost
Devices Under Replacement
To get devices under replacementget
Device status
To check device statusget
Device count
To get device count for a Tenant/Standalone accountget
MSP Replacement Count
Count of devices under replacement for a MSP customerget
Get MSP customers
Get all tenants under that MSP accountget
MSP replacement details
Get replacement details of all tenants under that MSP accountget

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

Device Routing - OSPF
Area
List OSPF Area Informationget
Interface
List OSPF Interface Informationget
Neighbor
List OSPF neighbor Informationget
LinkStateDatabase
List OSPF Link State Database Informationget

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

Device Routing - RIP
Interface
List RIP interfacesget
Neighbor
List of routes learned from a RIP neighborget
List RIP neighborsget
Route
List RIP routesget

Device Routing - RouteTable
Route
Get legacy routesget
Get routesget

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

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

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

Install Manager
Installer
Update an installerpatch
Delete an installerdelete
Get all installersget
Invite a new installerpost
QR code
Update a QR codepatch
Delete a QR codedelete
Create a QR codepost
Get QR code listget
Sites
Update site statuspatch
Get all assigned group to sites listget
For a given set of site names, assign Group Names for each device typepost

IoT - App Developer Portal
Apps
List App Versionsget
Submit Apppost
Get App Version Detailsget
Withdraw App Versionpost
Delete App Versiondelete
Validate App Nameget
Edit Draft Apppost
Create Apppost
List Draft Appsget
List Published and Suspended Appsget
Container Image
Validate Image Nameget
List Images For Max Versionget
Upload Imagepost
List Imagesget

IoT - Appstore
App Store
Find Recommended Appsget
Developer infoget
Upgrade developer apppost
Get the last 10 versions of an Appget
Delete Developer appdelete
Install Developer apppost
Get Developer App Iconget
Get Developer Appget
Edit Developer installed app configurationpost
Developer appsget
Upgrade apppost
Delete appdelete
Edit Installed app configurationpost
Install apppost
Get App Iconget
Get Appget
Count all installed appsget
Find all installed appsget
Search appsget

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

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

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

MSP
Customers
Delete a customerdelete
(Deprecated) Update a customerput
Get details of customerget
Update a customerput
Create a new customerpost
(Deprecated) Create a new customerpost
Get list of customers under the MSP account based on limit and offsetget
Get Country Code
Get list of country codeget
Users
Get list of users under the Customer account based on limit and offsetget
Get list of users under the MSP account based on limit and offsetget
Resources
Edit an existing resource for the MSPput
Get the resource under the MSPget
Devices
Get list of devices and licenses under the MSP account based on limit and offset, offset should be a multiple of the limit valueget
Un-assign all devices from Tenant/end-customer.put
Move a device to an end-customerput
Get list of devices and licenses under the Customer account based on limit and offset, offset should be a multiple of the limit valueget
Groups
Get list of customers mapped to MSP group based on limit and offset.get

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

Network Health
Network Health
Get data for all sitesget

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

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

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

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

RAPIDS
Rogues
List manually contained APsget
List neighbor APsget
List suspect APsget
List Interfering APsget
List Rogue APsget
WIDS
WIDS Eventsget
List Client Attacksget
List Infrastructure Attacksget

Refresh API Token
refresh_api_token
Refresh API tokenpost

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

SSO Configuration
SSO Support
Extract Saml metadata from filepost
Un-claim domaindelete
Add IDP configpost
Update IDP configurationput
Get domain listget
Get saml metadataget

Service Airgroup
Aruba airgroup
Retrieve node_list by identifier node-type node-idget
Delete complete Airgroup config for given Global or Groupdelete
Retrieve complete Airgroup config for given Global or Groupget
Retrieve all airgroup service policies at given Global or groupget
Delete airgroup service policy by name at Global or groupdelete
Create airgroup service policy by name at Global or grouppost
Create/Update airgroup service policy by name at Global or groupput
Retrieve airgroup service policy by name at Global or groupget
Delete role restrictions for given service at global or groupdelete
Create role restrictions for given service at global or grouppost
Create/Update role restrictions for given service at global or groupput
Retrieve role restrictions for given service at global or groupget
Retrieve all allowed roles for given serviceget
Delete allowed role for given servicedelete
Create allowed role for given servicepost
Create/Update allowed role for given serviceput
Retrieve allowed role for given serviceget
Retrieve all disallowed roles for given serviceget
Delete disallowed role for given servicedelete
Create disallowed role for given servicepost
Create/Update disallowed role for given serviceput
Retrieve disallowed role for given serviceget
Delete vlan restriction for given service at Global or groupdelete
Create vlan restriction for given service at Global or grouppost
Create/Update vlan restriction for given service at Global or groupput
Retrieve vlan restriction for given service at Global or groupget
Retrieve all allowed vlans for given serviceget
Delete allowed vlan for given servicedelete
Create allowed vlan for given servicepost
Create/Update allowed vlan for given serviceput
Retrieve allowed vlan for given serviceget
Retrieve all disallowed vlans for given serviceget
Delete disallowed vlan for given servicedelete
Create disallowed vlan for given servicepost
Create/Update disallowed vlan for given serviceput
Retrieve disallowed vlan for given serviceget
Delete General settings for given Global or Groupdelete
Create General settings for given Global or Grouppost
Create/Update General settings for given Global or Groupput
Retrieve General settings for given Global or Groupget
Delete airgroup_statusdelete
Create airgroup_statuspost
Create/Update airgroup_statusput
Retrieve airgroup_statusget
Retrieve all configured airgroup serversget
Delete airgroup server config by mac_addressdelete
Create airgroup server config by mac_addresspost
Create/Update airgroup server config by mac_addressput
Retrieve airgroup server config by mac_addressget
Delete network visibility config for given airgroup serverdelete
Create network visibility config for given airgroup serverpost
Create/Update network visibility config for given airgroup serverput
Retrieve network visibility config for given airgroup serverget
Retrieve complete visibility ap_list for given serverget
Delete entry for serial_number in visibility ap_list for given serverdelete
Create entry for serial_number in visibility ap_list for given serverpost
Create/Update entry for serial_number in visibility ap_list for given serverput
Retrieve entry for serial_number in visibility ap_list for given serverget
Delete role restrictions for given airgroup serverdelete
Create role restrictions for given airgroup serverpost
Create/Update role restrictions for given airgroup serverput
Retrieve role restrictions for given airgroup serverget
Retrieve all allowed roles for given serverget
Delete allowed role for given serverdelete
Create allowed role for given serverpost
Create/Update allowed role for given serverput
Retrieve allowed role for given serverget
Retrieve all disallowed roles for given serverget
Delete disallowed role for given serverdelete
Create disallowed role for given serverpost
Create/Update disallowed role for given serverput
Retrieve disallowed role for given serverget
Retrieve common_configget
Retrieve all standard Airgroup service definitionsget
Create standard service for given namepost
Create/Update standard service for given nameput
Retrieve standard service for given nameget
Retrieve all service-ids for given standard serviceget
Create service-id mapping for given standard servicepost
Create/Update service-id mapping for given standard serviceput
Retrieve service-id mapping for given standard serviceget
Delete Personal device visibility configurationdelete
Create Personal device visibility configurationpost
Create/Update Personal device visibility configurationput
Retrieve Personal device visibility configurationget
Retrieve all user-ids treated as admin users for device visibilityget
Delete entry in admin user-ids for given user_iddelete
Create entry in admin user-ids for given user_idpost
Create/Update entry in admin user-ids for given user_idput
Retrieve entry in admin user-ids for given user_idget
Retrieve all custom service definitionsget
Delete custom service for given namedelete
Create custom service for given namepost
Create/Update custom service for given nameput
Retrieve custom service for given nameget
Retrieve all service-ids in given custom serviceget
Delete service-id for given custom servicedelete
Create service-id for given custom servicepost
Create/Update service-id for given custom serviceput
Retrieve service-id for given custom serviceget

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

Service IDS IPS
Aruba ids ips
Retrieve node_list by identifier node-type node-idget
Delete complete config for IDS/IPSdelete
Create complete config for IDS/IPSpost
Create/Update complete config for IDS/IPSput
Retrieve complete config for IDS/IPSget
Retrieve config for all SIEM serversget
Delete SIEM server config for given siem_server_namedelete
Create SIEM server config for given siem_server_namepost
Create/Update SIEM server config for given siem_server_nameput
Retrieve SIEM server config for given siem_server_nameget
Delete SIEM server notification configurationdelete
Create SIEM server notification configurationpost
Create/Update SIEM server notification configurationput
Retrieve SIEM server notification configurationget

Service IPMS
Aruba ipms
Retrieve node_list by identifier node-type node-idget
Retrieve complete IPMS configget
Retrieve all IP address poolsget
Delete IP address pool for given pool_namedelete
Create IP address pool for given pool_namepost
Create/Update IP address pool for given pool_nameput
Retrieve IP address pool for given pool_nameget
Retrieve all IP ranges for given address pool_nameget
Create IP range by range_id for given address pool_namepost
Create/Update IP range by range_id for given address pool_nameput
Retrieve IP range by range_id for given address pool_nameget

Service Overlay Wlan
Aruba overlay wlan
Retrieve node_list by identifier node-type node-idget
Delete Complete Overlay-wlan config for given groupdelete
Create Complete Overlay-wlan config for given grouppost
Create/Update Complete Overlay-wlan config for given groupput
Retrieve Complete Overlay-wlan config for given groupget
Retrieve all Profile to Cluster mappings for given groupget
Delete Cluster mapping for given profile and profile_typedelete
Create Cluster mapping for given profile and profile_typepost
Create/Update Cluster mapping for given profile and profile_typeput
Retrieve Cluster mapping for given profile and profile_typeget
Retrieve all Cluster mappings for given profile and typeget
Delete Cluster mapping by redundancy-type and group-name for given profile and typedelete
Create Cluster mapping by redundancy-type and group-name for given profile and typepost
Create/Update Cluster mapping by redundancy-type and group-name for given profile and typeput
Retrieve Cluster mapping by redundancy-type and group-name for given profile and typeget

Service RAPIDS
Aruba Rapids
Retrieve node_list by identifier node-type node-idget
Delete complete RAPIDS configurationdelete
Create complete RAPIDS configurationpost
Create/Update complete RAPIDS configurationput
Retrieve complete RAPIDS configurationget
Retrieve all Classification rulesget
Delete Classification rule by rule_namedelete
Create Classification rule by rule_namepost
Create/Update Classification rule by rule_nameput
Retrieve Classification rule by rule_nameget
Delete match criteria for given classification rule_namedelete
Create match criteria for given classification rule_namepost
Create/Update match criteria for given classification rule_nameput
Retrieve match criteria for given classification rule_nameget
Retrieve all sites in Site-Excludes for given classification rule_nameget
Delete site by name in Site-Excludes for given classification rule_namedelete
Create site by name in Site-Excludes for given classification rule_namepost
Create/Update site by name in Site-Excludes for given classification rule_nameput
Retrieve site by name in Site-Excludes for given classification rule_nameget
Retrieve all sites in Site-Includes for given classification rule_nameget
Delete site by name in Site-Includes for given classification rule_namedelete
Create site by name in Site-Includes for given classification rule_namepost
Create/Update site by name in Site-Includes for given classification rule_nameput
Retrieve site by name in Site-Includes for given classification rule_nameget
Retrieve all exclude SSIDs for given classification rule_nameget
Delete essid in exclude SSIDs for given classification rule_namedelete
Create essid in exclude SSIDs for given classification rule_namepost
Create/Update essid in exclude SSIDs for given classification rule_nameput
Retrieve essid in exclude SSIDs for given classification rule_nameget
Retrieve all include SSIDs for given classification rule_nameget
Delete essid in include SSIDs for given classification rule_namedelete
Create essid in include SSIDs for given classification rule_namepost
Create/Update essid in include SSIDs for given classification rule_nameput
Retrieve essid in include SSIDs for given classification rule_nameget

Service SDWAN
Branch Mesh
Retrieve branch-mesh config for all labelsget
Retrieve branch-mesh by labelget
Delete branch-mesh config for given labeldelete
Create branch-mesh config for given labelpost
Create/Update branch-mesh config for given labelput
Retrieve branch-mesh config for given labelget
Retrieve all branch-devices for given branch-mesh labelget
Delete branch-devices by device serial numberdelete
Create branch-devices by device serial numberpost
Create/Update branch-devices by device serial numberput
Retrieve branch-devices by device serial numberget
Hub Configuration
Delete global hub configurationdelete
Retrieve global hub configurationget
Retrieve DC aggregate routes for all network segmentsget
Delete DC aggregate routes for given network segmentdelete
Create DC aggregate routes for given network segmentpost
Create/Update DC aggregate routes for given network segmentput
Retrieve DC aggregate routes for given network segmentget
Retrieve all DC aggregate route prefixes for given network segmentget
Delete DC aggregate routes by prefix for given network segmentdelete
Create DC aggregate routes by prefix for given network segmentpost
Create/Update DC aggregate routes by prefix for given network segmentput
Retrieve DC aggregate routes by prefix for given network segmentget
Delete transitdelete
Create transitpost
Create/Update transitput
Retrieve transitget
DC Preference
Delete branch/micro-branch configurationdelete
Create branch/micro-branch configurationpost
Create/Update branch/micro-branch configurationput
Retrieve branch/micro-branch configurationget
Retrieve all hubs-clusters for given branch groupget
Delete hub-clusters by cluster name and cluster groupdelete
Create hub-clusters by cluster name and cluster grouppost
Create/Update hub-clusters by cluster name and cluster groupput
Retrieve hub-clusters by cluster name and cluster groupget
Retrieve all hub devices for given branch groupget
Delete hubs by device serial numberdelete
Retrieve hubs by device serial numberget
Microbranch Data-Center
Delete microbranch-dc-clusterdelete
Create microbranch-dc-clusterpost
Create/Update microbranch-dc-clusterput
Retrieve microbranch-dc-clusterget
Retrieve hub-clustersget
Delete hub-clusters by identifier cluster-name cluster-groupdelete
Create hub-clusters by identifier cluster-name cluster-grouppost
Create/Update hub-clusters by identifier cluster-name cluster-groupput
Retrieve hub-clusters by identifier cluster-name cluster-groupget
Global Settings
Delete sdwan-globaldelete
Retrieve sdwan-globalget
Delete topologydelete
Create topologypost
Create/Update topologyput
Retrieve topologyget
Delete admin-statusdelete
Create admin-statuspost
Create/Update admin-statusput
Retrieve admin-statusget
Network Segments
Retrieve network-segment-policy config for all segmentsget
Delete network-segment-policy by segment namedelete
Create network-segment-policy by segment namepost
Create/Update network-segment-policy by segment nameput
Retrieve network-segment-policy by segment nameget
Route Policy
Delete route-policydelete
Retrieve route-policyget
Delete global load-balance orchestration configurationdelete
Create global load-balance orchestration configurationpost
Create/Update global load-balance orchestration configurationput
Retrieve global load-balance orchestration configurationget
Delete global hub route policy configurationdelete
Create global hub route policy configurationpost
Create/Update global hub route policy configurationput
Retrieve global hub route policy configurationget
Delete best-path-computationdelete
Create best-path-computationpost
Create/Update best-path-computationput
Retrieve best-path-computationget
Delete global graceful restart timer configurationdelete
Create global graceful restart timer configurationpost
Create/Update global graceful restart timer configurationput
Retrieve global graceful restart timer configurationget
Delete timerdelete
Create timerpost
Create/Update timerput
Retrieve timerget
Delete as-numberdelete
Create as-numberpost
Create/Update as-numberput
Retrieve as-numberget
Branch Aggregates
Retrieve branch-aggregate prefixes for all segmentsget
Delete global branch aggregate routes for given network segmentdelete
Create global branch aggregate routes for given network segmentpost
Create/Update global branch aggregate routes for given network segmentput
Retrieve global branch aggregate routes for given network segmentget
Retrieve all branch-aggregate prefixes for given segmentget
Delete global branch aggregate routes by prefix for given network segmentdelete
Create global branch aggregate routes by prefix for given network segmentpost
Create/Update global branch aggregate routes by prefix for given network segmentput
Retrieve global branch aggregate routes by prefix for given network segmentget
Tunnel Policy
Delete tunnel-policydelete
Create tunnel-policypost
Create/Update tunnel-policyput
Retrieve tunnel-policyget
Delete rekey-intervaldelete
Create rekey-intervalpost
Create/Update rekey-intervalput
Retrieve rekey-intervalget
Hub Mesh
Delete mesh-policydelete
Retrieve mesh-policyget
Retrieve hub-mesh config for all labelsget
Delete hub-mesh by labeldelete
Create hub-mesh by labelpost
Create/Update hub-mesh by labelput
Retrieve hub-mesh by labelget
Retrieve all hub-groups for given hub-mesh labelget
Delete hub-groups by namedelete
Create hub-groups by namepost
Create/Update hub-groups by nameput
Retrieve hub-groups by nameget
Group Configuration
Delete SDWAN global/group configurationdelete
Retrieve SDWAN global/group configurationget
aruba_sdwan
Retrieve node_list by identifier node-type node-idget

Service UCC
Aruba ucc
Retrieve node_list by identifier node-type node-idget
Delete complete UCC configdelete
Create complete UCC configpost
Create/Update complete UCC configput
Retrieve complete UCC configget
Delete UCC settingsdelete
Create UCC settingspost
Create/Update UCC settingsput
Retrieve UCC settingsget
Delete activatedelete
Create activatepost
Create/Update activateput
Retrieve activateget
Delete ucc_algdelete
Create ucc_algpost
Create/Update ucc_algput
Retrieve ucc_algget
Delete DSCP Priority configuration for Zoomdelete
Create DSCP Priority configuration for Zoompost
Create/Update DSCP Priority configuration for Zoomput
Retrieve DSCP Priority configuration for Zoomget
Delete DSCP Priority configuration for MS Teamsdelete
Create DSCP Priority configuration for MS Teamspost
Create/Update DSCP Priority configuration for MS Teamsput
Retrieve DSCP Priority configuration for MS Teamsget
Delete DSCP Priority configuration for SIP ALGdelete
Create DSCP Priority configuration for SIP ALGpost
Create/Update DSCP Priority configuration for SIP ALGput
Retrieve DSCP Priority configuration for SIP ALGget
Delete DSCP Priority configuration for Wifi Callingdelete
Create DSCP Priority configuration for Wifi Callingpost
Create/Update DSCP Priority configuration for Wifi Callingput
Retrieve DSCP Priority configuration for Wifi Callingget
Retrieve all configured DNS patternsget
Delete 'dns_patterns' config for given dns_patterndelete
Create 'dns_patterns' config for given dns_patternpost
Create/Update 'dns_patterns' config for given dns_patternput
Retrieve 'dns_patterns' config for given dns_patternget
Delete DSCP Priority configuration for 'Skype for Business'delete
Create DSCP Priority configuration for 'Skype for Business'post
Create/Update DSCP Priority configuration for 'Skype for Business'put
Retrieve DSCP Priority configuration for 'Skype for Business'get

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

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

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

Vgw
Get Cloud Accounts
Configure Cloud account for provider Zscalerget
Configure Cloud account for provider Azureget
Configure Cloud account for provider AWSget
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-iddelete

VisualRF
GeoFence
Disable geofencedelete
Enable geofencepost
Get status of geofenceget
Client Location
Get a specific floor and location of all its clientsget
Get location of a specific clientget
Rogue Location
Get a specific floor and location of all its rogue access pointsget
Get location of a specific rogue access pointget
Floorplan
Get location of a specific access pointget
Get a specific floor and location of all its access pointsget
Get background image of a specific floorget
Get details of a specific floorget
Get a specific building and its floorsget
Get a specific campus and its buildingsget
Get list of all campusesget
Import
get last import operation informationget
create floorplans using zip file (supported files are zip and .esx)post
Anonymization
Disable anonymizationdelete
Enable anonymizationpost
Get status of anonymizationget

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

200Successful response

201Created

400Bad Request

404Not Found

500Internal server error

defaultDefault response