Changes to Aruba Central APIs

The Swagger interface lists all the APIs Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. that are managed through Aruba Central. For more information on how to access the swagger interface, see Viewing Swagger Interface. Once you gain access to the Aruba Central APIs from swagger, select one of the service from the URL Uniform Resource Locator. URL is a global address used for locating web resources on the Internet. drop-down list. The URL allows you to access all the services and their respective APIs that are managed through Aruba Central. For example, to try out the monitoring service APIs, select the Monitoring service from the URL drop-down list and select one of the respective API under API Reference.

This section lists the new APIs, deprecated APIs, alternative APIs, and APIs removed from Aruba Central:

New APIs

The following table lists the new APIs:

Table 1: New APIs

New API

Description

Monitoring > Clients

  • [GET] /monitoring/v2/clients

This API is introduced to get a list of unified clients and it is backward compatible with the version 1 APIs (GET /monitoring/v1/clients/wired and GET /monitoring/v1/clients/wireless). This API version is introduced with the following parameter inclusions:

  • last_client_mac—Use this parameter to fetch the next set of clients beyond set limit. This is used to fetch the clients details beyond 10000 clients.
  • timerange— Use this to filter the unified client information based on the time range. By default, 3 hours is selected.
  • client_type—Use this to select the client type as WIRELESS or WIRED. By default, client type is selected as WIRELESS.
  • client_status—Use this to select either CONNECTED for a list of connected clients or FAILED_TO_CONNECT for a list failed clients. By default, the client status is selected as CONNECTED.
  • [GET] /monitoring/v2/clients/{macaddr}

This API is introduced to get the client details (wired and wireless).

Authentication & Policy > Client Policy

  • [GET] /client_policy

This API is introduced to fetch a policy that allows network access for registered clients, based on their MAC Media Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network. address and client profile tag.

  • [DELETE] /client_policy

This API is introduced to delete an existing policy to remove network access for all registered clients.

  • [PUT] /client_policy

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.

Authentication & Policy > Client Registration

  • [GET] /client_registration

This API is introduced to fetch the list of registered clients that are allowed to access the network.

  • [DELETE] /client_registration/{mac_address}

This API is introduced to delete the registered client and to remove network access.

  • [POST] /client_registration

This API is introduced to add a registered client to allow network access.

  • [PATCH] /client_registration/{mac_address}

This API is introduced to update Client Name for the registered clients.

Authentication & Policy > User policy

  • [GET] /user_policy

This API is introduced to fetch a policy that allows wireless network access for users, based on their user groups.

  • [DELETE] /user_policy

This API is introduced to delete existing policy to remove wireless network access for all users.

  • [PUT] /user_policy

This API is introduced to configure a policy to allow wireless network access for users, based on their user groups.

AI OPs > Wi-Fi Connectivity at Global

NOTE:  

  • For all AI Ops 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.
  • To get site_id mapping for site_name, use the below API available under Network Health.
    [GET] /branchhealth/v1/site
  • [GET] /aiops/v1/connectivity/global/stage/{stage}/export
  • [GET] /aiops/v1/connectivity/site/{site_id}/stage/{stage}/export
  • [GET] /aiops/v1/connectivity/group/{group}/stage/{stage}/export

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.

 

NOTE: You can set the time duration of three hours, twenty-four hours, one week, or one month.

 

 

AI OPs > AI Insights List

  • [GET] /aiops/v2/insights/global/list
  • [GET] /aiops/v2/insights/site/{site_id}/list
  • [GET] /aiops/v2/insights/ap/{ap_serial}/list
  • [GET] /aiops/v2/insights/client/{sta_mac}/list
  • [GET] /aiops/v2/insights/gateway/{gw_serial}/list
  • [GET] /aiops/v2/insights/switch/{sw_serial}/list

This APIs are introduced to get the list of insights for a given time duration.

 

NOTE: You can set the time duration of three hours, twenty-four hours, one week, or one month.

 

 

 

 

 

AI OPs > AI Insight Details

  • [GET] /aiops/v2/insights/global/id/{insight_id}/export
  • [GET] /aiops/v2/insights/site/{site_id}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/ap/{ap_serial}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/client/{sta_mac}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/gateway/{gw_serial}/id/{insight_id}/export
  • [GET] /aiops/v2/insights/switch/{sw_serial}/id/{insight_id}/export

This APIs are introduced to get details of single insight for a given time duration.

NOTE: You can set the time duration of three hours, twenty-four hours, one week, or one month.

 

 

 

 

 

MSP > Groups
  • [GET] /msp_api/v1/groups/{group_name}/customers

This API is introduced to get the list of customers mapped to MSP group based on limit and offset.

Troubleshooting
  • [GET] /troubleshooting/v1/running-config-backup/serial/{serial}

This API is introduced to get list of backups associated with the device serial.

 

  • [GET] /troubleshooting/v1/running-config-backup/serial/{serial}/prefix/{prefix}

This API is introduced to filter/list the backups associated with the device serial and starting with the prefix.

  • [GET] /troubleshooting/v1/running-config-backup/name/{name}

This API is introduced to fetch the backup stored against the given name.

  • [POST] /troubleshooting/v1/running-config-backup/serial/{serial}/prefix/{prefix}

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.

  • [POST] /troubleshooting/v1/running-config-backup/group_name/{group_name}/prefix/{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.

Configuration > WLAN Configuration
  • [GET] /configuration/full_hotspot/{group_name_or_guid}

This API is introduced to get the WLAN Wireless Local Area Network. WLAN is a 802.11 standards-based LAN that the users access through a wireless connection. list of an UI group.

 

  • [GET] /configuration/full_hotspot/{group_name_or_guid}/{mode_name}
This API is introduced to get the hotspot Hotspot 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.
  • [GET] /configuration/full_hotspot/{group_name_or_guid}/template

This API is introduced to get the WLAN default configuration.

  • [GET] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_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.

  • [POST] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to create a new hotspot.

  • [DELETE] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to delete an existing hotspot.

  • [PUT] /configuration/full_hotspot/{group_name_or_guid}/{hotspot_name}/{mode_name}

This API is introduced to update an existing hotspot.

Configuration > Templates
  • [GET] /configuration/v1/groups/{group}/templates

This API is introduced to get all templates in a group.

 

  • [UPDATE] /configuration/v1/groups/{group}/templates

This API is introduced to update the existing template in a group.

 

  • [POST] /configuration/v1/groups/{group}/templates

This API is introduced to create a new template in a group.

 

  • [DELETE] /configuration/v1/groups/{group}/templates/{template}

This API is introduced to delete an existing template in a group.

 

  • [GET] /configuration/v1/groups/{group}/templates/{template}

This API is introduced to get template text for a template group.

 

Service IPMS > Aruba ipms

NOTE: In the API parameter, make sure that the node_type and node_id fields are set to Global.

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/

This API is introduced to retrieve an ip range.

 

  • [DELETE] /ipms-config/v1/node_list/{node_type}/{node_id}/config/

This API is introduced to delete a config.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/

This API is introduced to retrieve a config.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/

This API is introduced to retrieve an address pool.

 

  • [DELETE] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to delete an address pool.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to retrieve an address pool by identifier pool name.

 

  • [POST] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to create an address pool by identifier pool name.

 

  • [PUT] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/

This API is introduced to create or update the address pool by identifier pool name.

 

  • [DELETE] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to delete the IP range by identifier range id.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to retrieve the IP range by identifier range id.

 

  • [POST] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to create IP range by identifier range id.

 

  • [PUT] /ipms-config/v1/node_list/{node_type}/{node_id}/config/address_pool/{pool_name}/ip_range/{range_id}/

This API is introduced to create or update the IP range by identifier range id.

 

  • [GET] /ipms-config/v1/node_list/{node_type}/{node_id}/

This API is introduced to have global level config for IPMS service.

 

Configuration > Groups

  • [POST] /configuration/v3/groups

This API is introduced to create groups with specified properties.

 

  • [PATCH] /configuration/v2/groups/{group}/properties

This API is introduced to update properties for the given group.

Guest > Summary

  • [GET] /guest/v1/summary

This API is introduced to get the summary statistics.

 

Client Match > Status

  • [GET] /loadbal-enable/v1/{tenant_id}

This API is introduced to retrieve Client Match Load Balancer status for a tenant.

 

  • [POST] /loadbal-enable/v1/{tenant_id}

This API is introduced to enable or disable Client Match Load Balancer for a particular tenant.

 

Monitoring > Switch APIs

NOTE: The below mentioned APIs are applicable to AOS-CX switches only.

  • [GET] /monitoring/v1/cx_switches/{serial}/vlan

This API is introduced to get the VLAN Virtual Local Area Network. In computer networking, a single Layer 2 network may be partitioned to create multiple distinct broadcast domains, which are mutually isolated so that packets can only pass between them through one or more routers; such a domain is referred to as a Virtual Local Area Network, Virtual LAN, or VLAN. information for CX switch.

  • [GET] /monitoring/v1/cx_switch_stacks/{stack_id}/vlan

This API is introduced to get the switch stack VLAN information for CX switch.

  • [GET] /monitoring/v1/cx_switches/{serial}/poe_detail

This API is introduced to get the switch port poe information for CX switch.

  • [GET] /monitoring/v1/cx_switches/{serial}/poe_details

This API is introduced to get the switch poe information for CX switch.

  • [GET] /monitoring/v1/cx_switches/{serial}/vsx

This API is introduced to get the switch vsx information for CX switch.

  • [GET] /monitoring/v1/cx_switches/{serial}/ports

This API is introduced to get the ports details for CX switch.

  • [GET] /monitoring/v1/cx_switch_stacks/{stack_id}/ports

This API is introduced to get the port details for a given stack_id for CX Switch.

  • [GET] /monitoring/v1/cx_switches/{serial}/ports/bandwidth_usage

This API is introduced to get the switch ports bandwidth usage over a time period for CX switch.

  • [GET] /monitoring/v1/cx_switches/{serial}/ports/errors

This API is introduced to get the switch ports in and out errors over a time period for CX switch.

Monitoring > Switch APIs

NOTE: The below mentioned APIs are applicable to AOS-S and AOS-CX switches.

  • [GET] /monitoring/v1/switches

This API is introduced to get the switch details.

  • [GET] /monitoring/v1/switches/bandwidth_usage/topn

This API is introduced to get top N switches details over a time period.

  • [DELETE] /monitoring/v1/switches/{serial}

This API is introduced to delete a switch.

  • [GET] /monitoring/v1/switches/{serial}

This API is introduced to get the switch details using serial number.

  • [GET] /monitoring/v1/switches/{serial}/chassis_info

This API is introduced to get the switch chassis details for chassis type switches.

  • [GET] /monitoring/v1/switch_stacks

This API is introduced to get the list of switch stacks.

  • [DELETE] /monitoring/v1/switch_stacks/{stack_id}

This API is introduced to delete the stack and associated switches.

  • [GET] /monitoring/v1/switch_stacks/{stack_id}

This API is introduced to get the switch stack details.

Configuration > AOS-S

NOTE: The isolation port feature is not supported for 2530 (YA/YB) switch models.

  • [GET] /configuration/v1/aos_switch/ports/groups/{group_name}

This API is introduced to get the port details like port id and name of the switch for a group.

 

  • [PUT] /configuration/v1/aos_switch/ports/groups/{group_name}

This API is introduced to update port details like port name for a group.

 

  • [GET] /configuration/v1/aos_switch/ports/devices/{device_serial}

This API is introduced to get the port details like port id and name for a device using the device serial number.

 

  • [PUT] /configuration/v1/aos_switch/ports/devices/{device_serial}

This API is introduced to update the port details like port name for a device using the device serial number.

 

  • [GET] /configuration/v1/aos_switch/vlans/groups/{group_name}

This API is introduced to get the VLANs details like VLAN id with tagged, untagged and isolated ports for a group.

 

  • [PUT] /configuration/v1/aos_switch/vlans/groups/{group_name}

This API is introduced to update VLANs details with tagged, untagged and isolated ports for a group.

  • [GET] /configuration/v1/aos_switch/vlans/devices/{device_serial}

This API is introduced to get VLANs details like VLAN id with tagged, untagged and isolated ports for a device.

 

  • [PUT] /configuration/v1/aos_switch/vlans/devices/{device_serial}

This API is introduced to update VLANs details with tagged, untagged and isolated ports for a device.

Configuration > Pre Provisioned Group

NOTE: For MSP—Device pre-provisioning can be done at tenant level using this API.

  • [POST] /configuration/v1/preassign

This API is introduced to pre-provision a group to the device.

Modified API

The following table lists the modified APIs:

Table 2: Modified APIs

Modified API

Description

Monitoring > Switch

  • [GET] /monitoring/v1/switch_stacks/{stack-id}/ports
  • [GET] /monitoring/v1/switches/{serial}/ports

Following fields are added in the response to ensure that the API call gets a list of ports, which includes:

  • out_errors per port
  • in_errors per port
  • [GET] /monitoring/v1/switches/{serial}
  • [GET] /monitoring/v1/switch_stacks/{stack_id}

The switch_type field is added to select the type of switch in the API endpoints. Following are the supported values:

  • ArubaCX
  • ArubaSwitch
  • MAAS
  • GET /monitoring/v1/switches
  • site parameter is introduced to filter the switches by site name.
  • site and stack_id fields are added to the response to get the site name and stack id details for the switches.
  • The switch_type field is added in the response to select the type of switch in the API endpoints. Following are the supported values:

    • AOS-CX

    • AOS-S
  • GET /monitoring/v1/switches/{serial}
  • site and stack_id fields are added to the response to get the site name and stack id details for the switches.
  • nae_aggr_status field is added to the response that informs about the switch status either as Critical, Major, Minor, Normal, and Warning. This field is only applicable for CX switches.
  • GET /monitoring/v1/switch_stacks
  • host_name parameter is introduced to filter the switches by host name.

Audit Event Logs

  • [GET] /auditlogs/v1/events
  • [GET] /platform/auditlogs/v1/logs
  • The limit parameter has been enhanced to return 100 audit events.
  • Following new parameters are introduced to filter audit events by time range:
    • start_time—Start time in epoch seconds. If start time is not specified, current time minus 90 days is automatically filled in as the start time.
    • end_time—End time in epoch seconds. If end time is not specified, current time is automatically filled in as the end time.

Monitoring > Client

  • [GET] /monitoring/v1/clients/wireless
  • [GET] /monitoring/v1/clients/wired
  • site parameter is introduced to filter the APIs by site name.
  • To retrieve clients beyond 10,000, use the last_client_mac parameter to fetch the next set of clients.

Monitoring > Gateway

 
  • [GET] /monitoring/v1/gateways

site parameter is introduced to filter the APIs by site name.

Monitoring > Access Points

  • [GET] /monitoring/v1/aps/{serial}
  • Following fields are added in the response to get the site and swarm name of the AP:
    • site_name
    • swarm_name
  • 6 GHz Gigahertz. radio support is added in the radios response field.
  • [GET] /monitoring/v3/aps/{serial}/rf_summary
  • [GET] /monitoring/v3/aps/bandwidth_usage

6 GHz radio support is added in the band parameter to filter by band Band refers to a specified range of frequencies of electromagnetic radiation. value 6.

  • [GET] /monitoring/v2/aps

6 GHz radio support is added in the radios response field.

Monitoring > Swarm

  • [GET] /monitoring/v1/swarms

swarm_name parameter is introduced to filter the API by swarm name.

Topology

  • [GET] /{site_id}

Following fields are added/modified in the response:

  • vlans—Lists the vlans configured on the device.
  • taggedVlans and untaggedVlan—Lists the tagged and untagged vlan associated to the ports of the edge. This is applicable only for switches.
  • In alignment with the redesign of HPE engineering terminology, the term Master in the API response changed to Conductor.
  • [GET] /devices/{device_serial}
  • In alignment with the redesign of HPE engineering terminology, the term Master in the API response changed to Conductor.

Configuration > Groups

  • [POST] /configuration/v2/groups

This API no longer supports the group password functionality and any value passed for this parameter would not be saved. Make sure that you use respective device configuration UI feature page to set the device admin password at group level.

  • [POST] /configuration/v2/groups/clone

upgrade_architecture field is introduced in the response body that allows the user to upgrade the architecture to AOS 10 for the coned group.

  • [GET] /configuration/v1/groups/properties

Following property values are added in the response body:

  • [GET] /configuration/v2/groups
  • This API no longer supports the group password functionality and any value passed for this parameter would not be saved. Make sure that you use respective device configuration UI feature page to set the device admin password at group level.
  • The limit Parameter is enhanced to include a maximum of 100 groups record to be returned.

MSP > Customers

  • [GET] /msp_api/v1/customers
  • [GET] /msp_api /v1/customers/{customer_id}

platform_customer_details field is added to the response.

  • [DELETE] /msp_api /v1/customers/{customer_id}

On calling, if the API response body includes a message saying Tenant has provisioned application. Please, remove them, try calling the API again.

NOTE: On calling this API, Aruba recommends that you wait for a few seconds to get a response. On execution, this delay occurs as the API un-assigns all the devices, unprovisions the NMS Network Management System. NMS is a set of hardware and/or software tools that allow an IT professional to supervise the individual components of a network within a larger network management framework. app, and deletes the tenant in CCS.

User Management > Roles

  • [PATCH] /platform/rbac/v1/apps/{app_name}/roles/{rolename}
  • [POST] /platform/rbac/v1/apps/{app_name}/roles

This API endpoint was previously used to modify user roles for 'Customer Management' and 'Portal Customization', along with many other roles. Starting from this release, please use the following API URI Uniform Resource Identifier. URI identifies the name and the location of a resource in a uniform format. (app name is account setting) for 'Customer Management' and 'Portal Customization' role modification:

  • /platform/rbac/v1/apps/account_setting/roles

Below is the sample JSON JavaScript Object Notation. JSON is an open-standard, language-independent, lightweight data-interchange format used to transmit data objects consisting of attribute–value pairs. JSON uses a "self-describing" text format that is easy for humans to read and write, and that can be used as a data format by any programming language. to create these two roles:

{ "rolename": "custom_role_1", "permission": "modify", "applications": [ { "permission": "view", "appname": "customer-management" }, { "permission": "view", "appname": "portal-customization" } ] }

Deprecated APIs

The following table lists the APIs that have been deprecated. These APIs will continue to function but could be removed in a future release. Aruba strongly discourages the use of these APIs and recommends that you use the alternative API.

Table 3: Deprecated APIs

Deprecated API

Alternative API

User Management

[GET] /accounts/v2/users

[GET] /platform/rbac/v1/users

[POST] /accounts/v2/users

[POST] /platform/rbac/v1/users

[POST] /accounts/v1/users/change_password

[POST] /platform/rbac/v1/users/{user_id}/password

[POST] /accounts/v1/users/reset_password

[POST] /platform/rbac/v1/users/{user_id}/password/reset

[GET] /accounts/v2/users/{user_id}

[GET] /platform/rbac/v1/users/{user_id}

[PATCH] /accounts/v2/users/{user_id}

[PATCH] /platform/rbac/v1/users/{user_id}

[POST] /accounts/v1/bulk_users

[POST] /platform/rbac/v1/bulk_users

[PATCH] /accounts/v1/bulk_users

[PATCH] /platform/rbac/v1/bulk_users

[GET] /accounts/v1/status/{cookie_name}

[GET] /platform/rbac/v1/status/{cookie_name}

[GET] /accounts/v1/roles

[GET] /platform/rbac/v1/roles

[POST] /accounts/v1/roles

[POST] /platform/rbac/v1/apps/{app_name}/roles

[GET] /accounts/v1/roles/{rolename}

[GET] /platform/rbac/v1/apps/{app_name}/roles/{rolename}

[DELETE] /accounts/v1/roles/{rolename}

[DELETE] /platform/rbac/v1/apps/{app_name}/roles/{rolename}

[PATCH] /accounts/v1/roles/{rolename}

[PATCH] /platform/rbac/v1/apps/{app_name}/roles/{rolename}

[GET] /accounts/v3/users

[GET] /platform/rbac/v1/users

[GET] /accounts/v1/users

[GET] /platform/rbac/v1/users

[POST] /accounts/v1/users

[GET] /platform/rbac/v1/users

[GET] /accounts/v1/users/{user_id}

[GET] /platform/rbac/v1/users/{user_id}

[PATCH] /accounts/v1/users/{user_id}

[PATCH] /platform/rbac/v1/users/{user_id}

[POST] /v2/subscriptions/assign

[POST] /platform/licensing/v1/subscriptions/assign

Presence Analytics

[GET] /presence/v2/config/thresholds

[GET] /presence/v3/config/thresholds

[POST] /presence/v2/config/thresholds

[POST] /presence/v3/config/thresholds

[GET] /presence/v2/analytics/aggregates

NA

[GET] /presence/v2/analytics/trends

[GET] /presence/v3/analytics/trends/passerby_visitors

[GET] /presence/v2/insights/top_sites

NA

[GET] /presence/v2/insights/bottom_sites

NA

[GET] /presence/v2/insights/sites/aggregates

[GET] /presence/v3/insights/sites/aggregates

[GET] /presence/v2/loyalty/aggregates

NA

[GET] /presence/v2/loyalty/trends

[GET] /presence/v3/analytics/trends/loyal_visitors

[GET] /presence/v2/loyalty/visits

[GET] /presence/v3/visit_frequency

  • [GET] /presence/v2/loyalty/aggregates/top_sites
  • [GET] [/presence/v2/loyalty/aggregates/bottom_sites
  • [GET] /presence/v2/loyalty/trends/top_sites
  • [GET] /presence/v2/loyalty/trends/bottom_sites

NOTE: Expected to be slow for customers with large number of sites.

NA

[GET] /presence/v2/loyalty/sites/aggregates

[GET] /presence/v3/insights/sites/aggregates

Monitoring > VPN

  • [GET] /monitoring/v1/vpn/usage
  • [GET] /monitoring/v2/vpn/usage

[POST] /monitoring/v3/vpn/usage

Monitoring > Access Points

[GET] /monitoring/v1/aps

[GET] /monitoring/v2/aps

[GET] /monitoring/v2/aps/{serial}/rf_summary

[GET] /monitoring/v3/aps/{serial}/rf_summary

  • [GET] /monitoring/v1/aps/bandwidth_usage
  • [GET] /monitoring/v2/aps/bandwidth_usage

[GET] /monitoring/v3/aps/bandwidth_usage

[GET] /monitoring/v1/aps/{serial}/uplink_history

NA

[GET] /monitoring/v1/aps/{serial}/neighbouring_clients

NA

[GET] /monitoring/v1/bssids

[GET] /monitoring/v2/bssids

[GET] /monitoring/v1/aps/bandwidth_usage/topn

[GET] /monitoring/v2/aps/bandwidth_usage/topn

Monitoring > Network

[GET] /monitoring/v1/networks

[GET] /monitoring/v2/networks

[GET] /monitoring/v1/networks/{network_name}

[GET] /monitoring/v2/networks/{network_name}

[GET] /monitoring/v1/networks/bandwidth_usage

[GET] /monitoring/v2/networks/bandwidth_usage

Deprecated Licensing

[GET] /subscriptions

[GET] /platform/licensing/v1/subscriptions

[GET] /subscriptions/stats

[GET] /platform/licensing/v1/subscriptions/stats

[GET] /services/enabled

[GET] /platform/licensing/v1/services/enabled

[GET] /subscriptions/assign

[POST] /platform/licensing/v1/subscriptions/assign

[POST] /subscriptions/unassign

[POST] /platform/licensing/v1/subscriptions/unassign

[GET] /services/config

[GET] /platform/licensing/v1/services/config

[DELETE] /subscriptions/devices/all

[DELETE] /platform/licensing/v1/subscriptions/devices/all

[POST] /subscriptions/devices/all

[POST] /platform/licensing/v1/subscriptions/devices/all

[DELETE] /msp/subscriptions/devices/all

[DELETE] /platform/licensing/v1/msp/subscriptions/devices/all

[POST] /msp/subscriptions/devices/all

[POST] /platform/licensing/v1/msp/subscriptions/devices/all

[GET] /autolicensing/services/{service}/status

[GET] /platform/licensing/v1/autolicensing/services/{service}/status

[DELETE] /customer/settings/autolicense

[DELETE] /platform/licensing/v1/customer/settings/autolicense

[GET] /customer/settings/autolicense

[GET] /platform/licensing/v1/customer/settings/autolicense

[POST] /customer/settings/autolicense

[POST] /platform/licensing/v1/customer/settings/autolicense

[DELETE] /msp/customer/settings/autolicense

[DELETE] /platform/licensing/v1/msp/customer/settings/autolicense

[GET] /msp/customer/settings/autolicense

[GET] /platform/licensing/v1/msp/customer/settings/autolicense

[POST] /msp/customer/settings/autolicense

[POST] /platform/licensing/v1/msp/customer/settings/autolicense

Monitoring > MobilityController

[GET] /monitoring/v1/mobility_controllers

[GET] /monitoring/v1/gateways

[GET] /monitoring/v1/mobility_controllers/{serial}

[GET] /monitoring/v1/gateways/{serial}

[DELETE] /monitoring/v1/mobility_controllers/{serial}

[DELETE] /monitoring/v1/gateways/{serial}

[GET] /monitoring/v1/mobility_controllers/{serial}/uplinks

[GET] /monitoring/v1/gateways/{serial}/uplinks

[GET] /monitoring/v1/mobility_controllers/uplinks/bandwidth_usage

[GET] /monitoring/v1/gateways/{serial}/uplinks/bandwidth_usage

[GET] /monitoring/v1/mobility_controllers/{serial}/uplinks/tunnel_stats

[GET] /monitoring/v1/gateways/{serial}/tunnels/stats

[GET] /monitoring/v1/mobility_controllers/uplinks/wan_compression_stats

[GET] /monitoring/v1/gateways/{serial}/uplinks/wan_compression_stats

[GET] /monitoring/v1/mobility_controllers/uplinks/distribution

[GET] /monitoring/v1/gateways/{serial}/uplinks/distribution

[GET] /monitoring/v1/mobility_controllers/{serial}/ports/bandwidth_usage

[GET] /monitoring/v1/gateways/{serial}/ports/bandwidth_usage

[GET] /monitoring/v1/mobility_controllers/{serial}/ports

[GET] /monitoring/v1/gateways/{serial}/ports

[GET] /monitoring/v1/mobility_controllers/{serial}/tunnels

[GET] /monitoring/v1/gateways/{serial}/tunnels

[GET] /monitoring/v1/mobility_controllers/{serial}/dhcp_clients

[GET] /monitoring/v1/gateways/{serial}/dhcp_clients

[GET] /monitoring/v1/mobility_controllers/{serial}/dhcp_servers

[GET] /monitoring/v1/gateways/{serial}/dhcp_pools

[GET] /monitoring/v1/mobility_controllers/{serial}/vlan

[GET] /monitoring/v1/gateways/{serial}/vlan

Configuration > Pre Provisioned Group

[POST] /device_management/v1/group/assign

NA

Removed APIs

The following table lists the APIs that have been removed and the alternative APIs:

Table 4: Removed and Alternative APIs

Removed API

Alternative API

User Management

[DELETE] /accounts/v1/users/{user_id}

[DELETE] /platform/rbac/v1/users/{user_id}

[DELETE] /accounts/v1/bulk_users

[DELETE] /platform/rbac/v1/bulk_users

Device Management

[GET] /configuration/v1/devices/{device_serial}/mobility_master/

[GET] /device_management/v1/mobility_master/{device_serial}

[POST] /configuration/v1/devices/{device_serial}/mobility_master/{mm_name}

[POST] /device_management/v1/mobility_master/{device_serial}/{mm_name}

WIDS

  • [GET] /monitoring/v1/wids/rogue_aps
  • [GET] /monitoring/v1/wids/interfering_aps
  • [GET] /rapids/v1/rogue_aps
  • [GET] /rapids/v1/interfering_aps

NOTE: Rogue Detection is disabled, contact Aruba Support to enable this feature.

[GET] /monitoring/v1/wids/infrastructure_attacks

[GET] /rapids/v1/wids/infrastructure_attacks

[GET] /monitoring/v1/wids/client_attacks

[GET] /rapids/v1/wids/client_attacks

[GET] /monitoring/v1/wids/events

[GET] /rapids/v1/wids/events

Configuration

  • [PUT] /configuration/v1/msp/templates—This API updates the MSP customer level template to all template groups for the end customers.
  • [PUT] /configuration/v1/msp/templates/customer/{cid}—This API updates the end customer-level template and applies the template to all template groups.

NOTE: To achieve the functionality of [PUT] /configuration/v1/msp/templates API, it is recommended that you use the combination of 1, 3, and 4 numbered APIs from the alternate API column.

NOTE: To achieve the functionality of [PUT] /configuration/v1/msp/templates/customer/{cid} API, it is recommended that you use the combination of 2 and 4 numbered APIs from the alternate API column.

  1. [PUT] /configuration/v2/msp/templates—This API is used to update the template at MSP level.
  2. [PUT] /configuration/v2/msp/templates/customer/{cid}—This API is used to update the template at end customer level.
  3. [POST] /configuration/v2/msp/templates/end_customers/{device_type}/{version}/{model}—This API is used to apply the MSP level template to end customers.
  4. [POST]/configuration/v2/msp/templates/end_customers/{cid}/{device_type}/{version}/{model}/group—This API is used to apply end customer-level templates to the end customer's template groups.

The following table lists the APIs that have been removed:

Table 5: Removed APIs

Removed APIs

ACP MSP

  • [GET] /platform/msp_api/v1/customers/{customer_id}
  • [PUT] /platform/msp_api/v1/customers/{customer_id}
  • [DELETE] /platform/msp_api/v1/customers/{customer_id}
  • [GET] /platform/msp_api/v1/customers
  • [POST] /platform/msp_api/v1/customers

Clarity

  • [GET] /clarity/v1/overview/healthscore
  • [GET] /clarity/v1/overview/healthscore/dns
  • [GET] /clarity/v1/overview/network_stats
  • [GET] /clarity/v1/ssid/names
  • [GET] /clarity/v1/overview/reasons
  • [GET] /clarity/v1/overview/attempts
  • [GET] /clarity/v1/overview/device_attempts
  • [GET] /clarity/v1/trend/healthscore
  • [GET] /clarity/v1/trend/healthscore/dns
  • [GET] /clarity/v1/trend/network_stats
  • [GET] /clarity/v1/clients/search/partial
  • [GET] /clarity/v1/clients/search/absolute
  • [GET] /clarity/v1/clients/details
  • [GET] /clarity/v1/clients/stats
  • [GET] /clarity/v1/insights
  • [GET] /clarity/v1/insights/details
  • [GET] /clarity/v1/insights/distribution
  • [GET] /clarity/v1/license

Attributes

[GET] /monitoring/v1/attribute_values

Presence Analytics

  • [POST] /presence/v1/config/thresholds
  • [GET] /presence/v1/config/thresholds
  • [GET] /presence/v1/analytics/aggregates
  • [GET] /presence/v1/analytics/trends
  • [GET] /presence/v1/insights/top_sites
  • [GET] /presence/v1/insights/bottom_sites
  • [GET] /presence/v1/insights/sites/aggregates

Configuration > Groups

  • [PATCH] /configuration/v1/groups/{group}
  • [PATCH] /configuration/v1/groups/{group}/properties