Example of Supported API Categories

The following table is an example of API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. Categories supported in HPE Aruba Networking Central.

Table 1: Example of API Categories and Description

API Category

Description

Monitoring

Gets network, client, and event details. It also allows you to manage labels and switches.

Configuration

Allows you to configure and retrieve the following:

  • Groups
  • Templates
  • Device Configuration

NOTE: For CX devices, only template groups support the template APIs and device configuration APIs.

AppRF

Gets Top N AppRF statistics.

Guest

Gets visitor and session details of the portal.

MSP

Allows you to manage and retrieve the following:

  • Customers
  • Users
  • Resources
  • Devices

HPE Aruba Networking has enforced a request limit for the following APIs:

  • GET /msp_api/v1/customers
  • GET /msp_api/v1/customers/{customer_id}/devices
  • GET /msp_api/v1/devices
  • PUT /msp_api/v1/customers/{customer_id}/devices

The maximum limit is set to 50 per API call. If you exceed this limit, the API call returns the HTTP Hypertext Transfer Protocol. The HTTP is an application protocol to transfer data over the web. The HTTP protocol defines how messages are formatted and transmitted, and the actions that the w servers and browsers should take in response to various commands. error code 400 and the following error message: LIMIT_REQUEST_EXCEEDED.

User Management

Allows you to manage users and also allows you to configure various types of users with a specific level of access control.

Audit Event Logs

Gets a list of audit events and the details of an audit event.

New Device Inventory

Gets device details and device statistics.

New Licensing

Allows you to manage and retrieve subscription keys.

Presence Analytics

Allows you to configure the Presence Analytics application. It also retrieves site and loyalty data.

Device Management

Allows you to manage devices.

Firmware

Allows you to manage the firmware.

Troubleshooting

Gets a list of troubleshooting commands for a specific type of device.

Notification

Gets notification alerts generated for events pertaining to device provisioning, configuration, and user management.

Unified Communications

Retrieves data for all sessions for a specific time interval. It also retrieves the following:

Refresh API Token

Allows you to refresh the API token.

Reporting

Gets the list of configured reports for the given customer ID.

Network Health

Allows you to get data for all the labels and sites.

Webhook

Allows you to add, or delete Webhooks, and get or refresh Webhook tokens. See Webhooks for further details on Webhook.

VisualRF

Allows you to retrieve information on floor plans, location of APs, clients, and rogue devices.

DPS Monitoring

Gets DPS compliance and session statistics for all the links of a device belonging to a specific policy.

Swagger documentation displays the complete list of APIs and the corresponding documentation. To access the Swagger documentation, see Viewing Swagger Interface.