Jump to Content
Home
Guides
API Reference
AOS 8
AOS-CX
Central
New Central
New Central - Configuration API
ClearPass Policy Manager
User Experience Insight
Fabric Composer
EdgeConnect SD-WAN
v2.5.7
v2.5.8
Guides
API Reference
GitHub
Airheads Developer Community
Log In
API Reference
Guides
API Reference
GitHub
Airheads Developer Community
Log In
Central
v2.5.8
API Reference
Get task status
Search
JUMP TO
ACP Audit Trail
audit
Get all audit logs
get
Get details of an audit log
get
ACP OFC Api Handler
Flowhandler
Enable/Disable the Syslog App.
post
Enable Syslog App on a list of given device SerialIDs.
post
Check Status of Syslog App for given SerialIDs.
post
Check Status of Enabled Flow SerialID
get
AIOps
Wi-Fi Connectivity Dashboard
Wi-Fi Connectivity at Global
get
Wi-Fi Connectivity at Site
get
Wi-Fi Connectivity at Group
get
AI Insights List
List AI Insights for a Network
get
List AI Insights for a Site
get
List AI Insights for an AP
get
List AI Insights for a Client
get
List AI Insights for a Gateway
get
List AI Insights for a Switch
get
AI Insight Details
AI Insight Details for a Network
get
AI Insight Details for a Site
get
AI Insight Details for an AP
get
AI Insight Details for a Client
get
AI Insight Details for a Gateway
get
AI Insight Details for a Switch
get
AirGroup
Summary
Get AirGroup Traffic Summary in terms of Packets
get
Retrieves device summary
get
Trend
Get temporal data about AirGroup based on the parameter passed
get
List
Retrieves list of labels
get
Get all the uncached services encountered by AirGroup
get
Retrieves a list of all hostnames
get
Distribution
Retrieves a summary of all the services queried for.
get
Retrieves a summary of the servers connected to AirGroup
get
Stats
Retrieves the suppression factor
get
AirMatch
Radio
Get reporting radio of a specific radio MAC
get
Get all reporting radio for a customer
get
Get nbr pathloss of a neighbor MAC heard by a specific radio MAC
get
Get all nbr pathloss for a customer and band
get
Get RF events of a specific radio MAC
get
Get radar and noise RF events of a specific radio MAC
get
Get history of a specific radio MAC
get
Get all nbr pathloss for a customer and radio MAC
get
Get all static radios for a customer
get
Get EIRP distribution
get
Get EIRP reasons
get
Get information about radio
get
Get neighbor stats information
get
Get all RF events of a tenant id
get
Get all radar and noise RF events of a tenant
get
Get EIRP reasons
get
Get board limits of a specific radio MAC
get
Get radio neighbor list
get
AP
Get AP info of a specific AP ethernet MAC
get
Get AP info for all AP's
get
Get number of AP's and AP models
get
Returns all device (AP) running configuration for a customer
get
Returns device (AP) running configuration
get
Change a device running config
put
Returns device (AP) running configuration
get
Change a device running config
put
Returns all device (AP) running configuration for a customer
get
Get feasibility ap info of a specific AP ethernet MAC
get
Get AP neighbor list
get
Get AP neighbor list
get
Telemetry
Bootstrap
post
Purge
post
Solution
Get optimizations for tenant
get
Run the algorithm for the solution
post
Get solution of a specific radio MAC
get
Get all solutions for a customer
get
Get optimizations for tenant's requested partition
get
Miscellaneous
Gets radios deployment status
get
Returns all device (AP) running configuration for all customers
get
Returns device (AP) running configuration
get
Schedule
RMQ message triggers a recompute of the schedule due to change in tenant timezone/deploy hour details
post
RMQ message triggers a runnow job for a certain tenant
post
Get the schedule of all jobs computed by the scheduler
get
Get the jobs to be sent to deployer for AirMatch solution deployment
get
Get the list of jobs generated by scheduler
get
Get the list of unique timezone and deploy hours per tenant
get
Trigger - RMQ message with on-demand compute for a provided tenant id
post
Radio feasibility
Trigger update of radio feasibility
put
Get radio feasibility of a specific radio MAC
get
Get all radio feasibility for a customer
get
Get radio_feasibility of a specific radio MAC
get
Get all radio feasibility for a customer
get
Get feasibility radio info of a specific radio MAC
get
Deployer
Get a list of pending deployments for a tenant id
get
Trigger computation complete message
post
RMQ message generates southbound test action-msg
post
Trigger test-config update
post
RF domain
Get partition information
get
Start partition process
post
AppRF
Overview
(Deprecated) Gets Top N Apprf Statistics
get
Gets Top N Apprf Statistics (V2 Version)
get
Applications
Gets Top N Applications
get
Web Categories
Gets Top N Web categories
get
App Categories
Gets Top N App categories
get
Web Reputations
Gets Top Web Reputations
get
AppRF IAP Meta Info
Gets Web Reputation id to name mapping
get
Gets Application id to name mapping
get
Gets Application Category id to name mapping
get
Gets Web Category id to name mapping
get
Audit Event Logs
audit
Get all audit events for all groups
get
Get details of an audit event/log
get
Authentication & Policy
Authentications and Sessions
Fetch list of authentications using Aruba Air Pass.
get
Fetch list of authentications using Cloud Identity.
get
Fetch details of a specific authentication using either Cloud Identity or Aruba Air Pass.
get
Fetch list of sessions using Aruba Air Pass.
get
Fetch list of sessions using Cloud Identity.
get
Client Policy
Fetch network access policy for registered clients.
get
Configure or update network access policy for registered clients.
put
Delete existing Client Policy.
delete
Reset Client Policy.
put
Client Registration
Fetch list of registered clients.
get
Add registered client.
post
Delete registered client.
delete
Update registered client name.
patch
Wi-Fi Easy Connect
Fetch list of registered clients.
get
Register a client.
post
Update registered client with bootstrapping key.
put
Delete registered client.
delete
User Policy
Fetch policy that allows wireless network access for users.
get
Configure policy to allow wireless network access for users.
put
Delete existing User Policy.
delete
Reset User Policy.
put
Download
Fetch all Named MPSK as a CSV file.
get
Fetch all Mac Registrations as a CSV file.
get
MPSK Networks Configs
Read all configured MPSK networks.
get
Create an MPSK network config
post
Read one MPSK network config.
get
Edit an MPSK network config
put
Delete an MPSK network configuration.
delete
Read all named MPSK
get
Add a named MPSK config
post
Read a named MPSK config
get
Edit a Named MPSK Config
put
Delete a Named MPSK Config
delete
Partially Edit a Named MPSK Config
patch
Read MPSK Usage Stats
get
File Upload
Upload file
post
Read errors in last file upload
get
Read upload status of last file upload
get
Terminate Upload
put
Upload file
post
Read errors in last file upload
get
Read upload status of last file upload
get
Terminate Upload
put
MAC Registration
Fetch list of mac registrations.
get
Add mac registration.
post
Delete registered mac registration.
delete
Update registered client name.
patch
User Management
Fetches certificate details of a user
get
Revoke a user's device certificate
post
Ble Beacon Service
BleBeaconService
Retrieve ble configured beacons
get
Retrieve ble running beacons
get
Retrieve ble beacon profiles
get
Config ble beacon profile
post
Edit ble beacon profile
post
Delete ble beacon profile
delete
Update one device beacon config
post
Delete one device beacon config
delete
Client Match
Status
Get the status of Client Match for a tenant
get
Enable or disable Client Match for a particular tenant.
post
Get the status of Client Match Load Balancer for a tenant
get
Enable or disable Client Match Load Balancer for a particular tenant.
post
Get the status of Client Match Band Steer to 6GHz for a tenant
get
Enable or disable Client Match Band Steer to 6GHz for a particular tenant.
post
Unsteerable
Get all unsteerable entries for a tenant
get
Get the unsteerable state of a client
get
Set the unsteerable state of a client
post
Delete the unsteerable state of a client
delete
Cloud Connect
Cloud Connect
Update Custom cloud provider endpoint config
put
Create Custom cloud provider endpoint config
post
Delete Custom cloud provider endpoint config
delete
Update Zscaler cloud provider endpoint config
put
Create Zscaler cloud provider endpoint config
post
Delete Zscaler cloud provider endpoint config
delete
Update AWS cloud provider endpoint config
put
Create AWS cloud provider endpoint config
post
Delete AWS cloud provider endpoint config
delete
Update Azure cloud provider endpoint config
put
Create Azure cloud provider endpoint config
post
Delete Azure cloud provider endpoint config
delete
Update Prisma cloud provider endpoint config
put
Create Prisma cloud provider endpoint config
post
Delete Prisma cloud provider endpoint config
delete
Trigger cloud provider endpoint scan.
get
Get all Cloud Provider endpoints.
get
Get Zscaler node scan details.
get
Get configured
