Changes to Aruba Central APIs
This section lists the new APIsApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software., deprecated APIs, alternative APIs, and APIs removed from Aruba Central:
New APIs
The following table lists the new APIs:
New API |
Description |
---|---|
|
|
|
This API is introduced to get a list of unified clients and it is backward compatible with the version 1 APIs ( and ). This API version is introduced with the following parameter inclusions:
|
|
This API is introduced to get the client details (wired and wireless). |
|
|
|
This API is introduced to fetch a policy that allows network access for registered clients, based on their MACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network. address and client profile tag. |
|
This API is introduced to delete an existing policy to remove network access for all registered clients. |
|
This API is introduced to configure or update a policy that allows network access for registered clients, based on their MAC address and client profile tag. |
|
|
|
This API is introduced to fetch the list of registered clients that are allowed to access the network. |
|
This API is introduced to delete the registered client and to remove network access. |
|
This API is introduced to add a registered client to allow network access. |
|
This API is introduced to update Client Name for the registered clients. |
|
|
|
This API is introduced to fetch a policy that allows wireless network access for users, based on their user groups. |
|
This API is introduced to delete existing policy to remove wireless network access for all users. |
|
This API is introduced to configure a policy to allow wireless network access for users, based on their user groups. |
|
|
|
This API is introduced to get the WLANWireless Local Area Network. WLAN is a 802.11 standards-based LAN that the users access through a wireless connection. list of an UI group.
|
|
This API is introduced to get the hotspotHotspot refers to a WLAN node that provides Internet connection and virtual private network (VPN) access from a given location. A business traveler, for example, with a laptop equipped for Wi-Fi can look up a local hotspot, contact it, and get connected through its network to reach the Internet. list of an UI group or swarm with mode name. |
|
This API is introduced to get the WLAN default configuration. |
|
This API is introduced to initiate backup of running config for the switch with the given serial and store output against a name starting with the given prefix. |
|
This API is introduced to create a new hotspot. |
|
This API is introduced to delete an existing hotspot. |
|
This API is introduced to update an existing hotspot. |
|
|
|
This API is introduced to get list of backups associated with the device serial.
|
|
This API is introduced to filter/list the backups associated with the device serial and starting with the prefix. |
|
This API is introduced to fetch the backup stored against the given name. |
|
This API is introduced to initiate backup of running config for the switch with the given serial and store output against a name starting with the given prefix. |
|
This API is introduced to initiate backup of running config for switches in the group and store output against names starting with the given prefix. |
For all APIs, AI Insights will get triggered only when there are failure events in the user network, so all Insights might not be present all the time. Therefore, providing an empty API response for a selected time period.
|
|
|
This APIs are introduced to get the overall Connectivity Information for a given time duration. Use stage parameter to get the information for that stage.
|
|
|
|
This APIs are introduced to get the list of insights for a given time duration
|
|
|
|
This APIs are introduced to get details of single insight for a given time duration.
|
In the API parameter, make sure that the and fields are set to . |
|
|
This API is introduced to retrieve an ip range.
|
|
This API is introduced to delete a config.
|
|
This API is introduced to retrieve a config.
|
|
This API is introduced to retrieve an address pool.
|
|
This API is introduced to delete an address pool.
|
|
This API is introduced to retrieve an address pool by identifier pool name.
|
|
This API is introduced to create an address pool by identifier pool name.
|
|
This API is introduced to create or update the address pool by identifier pool name.
|
|
This API is introduced to delete the IP range by identifier range id.
|
|
This API is introduced to retrieve the IP range by identifier range id.
|
|
This API is introduced to create IP range by identifier range id.
|
|
This API is introduced to create or update the IP range by identifier range id.
|
|
This API is introduced to have global level config for IPMS service.
|
Modified API
The following table lists the modified APIs:
Modified API |
Description |
---|---|
|
|
|
|
|
|
|
Following fields are added/modified in the response:
|
|
|