Modified APIs

The following table lists the APIs Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. modified in the current release:

Table 1: Modified APIs

Modified API

Description

VisualRF > Client Location

  • [GET] /visualrf_api/v1/floor/{floor_id}/client_location

If anonymization is enabled, the API call gets the hashed_mac field instead of the device_mac field.

  • [GET] /visualrf_api/v1/client_location/{macaddr}
  • [GET] /visualrf_api/v1/floor/{floor_id}/client_location

The API call returns the device_mac address instead of client_mac address

VisualRF > Rogue Location

  • [GET] /visualrf_api/v1/floor/{floor_id}/rogue_location

If anonymization is enabled, the API call gets the hashed_mac field instead of the device_mac field.

  • [GET] /visualrf_api/v1/rogue_location/{macaddr}
  • [GET] /visualrf_api/v1/floor/{floor_id}/rogue_location

The API call returns the device_mac address instead of client_mac address

VisualRF > Floorplan

  • [GET] /visualrf_api/v1/campus
  • [GET] /visualrf_api/v1/campus/{campus_id}

These APIs were listed as deprecated in Aruba Central 2.5.4, however they are re-introduced back in Aruba Central 2.5.6.

User Management> Users

  • [GET] /platform/rbac/v1/users

The following values are added to the app_name parameter:

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

To create or update a user account if you input allgroups as the groups value in the body, then the changes are applied to all groups.

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

To create a new password using these APIs, refer to the password requirements below:

  • Must be at least 8 characters long
  • Must contain at least one lowercase character (a-z)
  • Must contain at least one Uppercase character (A-Z) 
  • Must contain at least one special character
  • Must not match your username, first name or last name
  • Must be different that your previous six password

User Management> Roles

The following values are added to the app_name parameter:

  • nms—corresponds to Aruba Central application
  • account_settings—corresponds to HPE GreenLake Edge to Cloud Platform (CCS) application

The following values are added to the app_name parameter:

  • nms—corresponds to Aruba Central application
  • account_settings—corresponds to HPE GreenLake Edge to Cloud Platform (CCS) application.

 

In the body params parameter the following values are updated:

  • The rolename and applications values are mandatory for creating or editing a role.
  • The top level permission value refers to the Other Applications option available in the list of CENTRAL Permissions when creating or updating a role using HPE GreenLake Edge to Cloud Platform. Other Applications enables you to set a permission for Notifications and Virtual Gateway.
  • Inside the applications array, at least one appname and one permission value must be entered to create or edit a role.

Service Airmatch

  • [GET] /airmatch-config/v1/node_list/{node_type}/{node_id}/config/system/
  • [POST] /airmatch-config/v1/node_list/{node_type}/{node_id}/config/system/
  • [PUT] /airmatch-config/v1/node_list/{node_type}/{node_id}/config/system/
  • [GET] /airmatch-config/v1/node_list/{node_type}/{node_id}/config/
  • [POST] /airmatch-config/v1/node_list/{node_type}/{node_id}/config/
  • [PUT] /airmatch-config/v1/node_list/{node_type}/{node_id}/config/
  • [GET] /airmatch-config/v1/node_list/{node_type}/{node_id}/

In these APIs, the quality_threshold parameter is deprecated and replaced with the following parameters:

For all of the above parameters, you can set the quality threshold value between 0 and 100. The default value is 8.

Monitoring > Site

  • [POST] /central/v2/sites
  • [PATCH] /central/v2/sites/{site_id}

The following words cannot be used as a site name while creating or updating a site:

  • Default
  • Default Site
  • Default_Site
  • Default-Site

The above names are not case-sensitive; hence you cannot use words like DeFauLT_sIte as site name.

 

A site can be created and updated with either address or geolocation (optional).

 

  • [DELETE] /central/v2/sites/{site_id}
A site can be deleted only when all the devices are disassociated from the site you want to delete.

Monitoring > Label

  • [DELETE] /central/v1/labels/{label_id}
A label can be deleted only when the label is not assigned to any device.

MSP > Customers

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

A tenant account can be deleted only when all the devices are unassigned from the account you want to delete. If there is a device assigned to a tenant account, the API call will display an error message.

Configuration > Devices

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

This API supports only template groups for CX devices.

Configuration > WLAN Configuration

Configuration > AP Configuration

In the WLAN Wireless Local Area Network. WLAN is a 802.11 standards-based LAN that the users access through a wireless connection. configuration and AP configuration categories, the device serial number of AOS 10.x APs is added to the parameter. You can now use the following parameter values to call the APIs:

  • Device serial number of AOS 10.x APs
  • Group name
  • Swarm GUID

To view the APIs modified in previous releases, see APIs Modified In Previous Releases.