Jump to Content

Home Guides API Reference

Guides API Reference GitHub Airheads Developer Community Log In

API Reference

Guides API Reference GitHub Airheads Developer Community Log In

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

DPS

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

DPS

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

Get group for a device.

get https://{api-base-url}/configuration/v1/devices/{device_serial}/group

Language

Credentials

Bearer

URL

Click Try It! to start a request and see the response here!

Terms of Service

© Copyright 2024 Hewlett Packard Enterprise Development LP