API Change Log in January 2025

Monitoring > Access Points

This API is used to fetch information of all Access Point associated with a given tenant or site. Information such as MAC address, name, status, etc. are displayed for the access point.

To filter the list, you must use ODATA 4.0 filter format.
ODATA 4.0 filter example: filter=siteId eq 'site123' and status eq 'ONLINE'.

This API is used to fetch information of a specific Access Point associated with a given site. Information such as MAC address, name, status, radios, ports, modem, and WLANs, etc. are displayed for the given access point serial number.

This API is used to fetch information of Access Points that are consuming the highest amount of bandwidth over a time period for a given site. The default value for the limit parameter is 10.

Monitoring > Application Visibility

This API is used to fetch the list of applications accessed in a site by all clients or by a specific client.

Monitoring > Location Services

This API is used to fetch a list of the latest locations of all the Wi-Fi clients that matches the query parameters. This API is used with the following parameters:

• latest-connected-client-mac-address—This parameter fetches the latest location information of a specific client based on its MAC address.

  For example, [GET] /network-monitoring/v1alpha1 /wifi-clients-locations?latest-connected-client-mac=<client_mac>.

  The client must exist in the system and be in a connected state. This parameter does not support ODATA 4.0 filters and pagination.

• latest-location-per-client—This parameter fetches the list of latest location of all the Wi-Fi clients that matches the query parameters.

  For example, [GET] /network-monitoring/v1alpha1/wifi-clients-locations?latest-location-per-client=1&filter=site,floor,connected, and so on.

  Currently, this parameter only supports a value of 1, as it does not account for the clients' location history. You must provide an ODATA 4.0 filter with at least a siteId. Other supported filters are floorId, buildingId, connected, associated, startQueryTime, limit, and offset.

  ODATA 4.0 filter example—filter=siteId eq 'site123' and floorId in ('floor-abc', ‘floor-xyz’) and connected eq true

Monitoring > Device Location

The API is used to fetch the list of devices for which the location information is available.

An example of ODATA 4.0 filter format—filter=floorId eq 'floor-abc'.

The API is used to fetch specific device location information using the resource ID. To obtain the resource ID assigned to a device, execute the [GET] /network-monitoring/v1alpha1/sites/{siteID}/device-locations API call.

The API is used to fetch location information of a specified device. The response field displays the following location information:

• consolidatedLocation
• gpsLocation
• autoPlacedLocation
• autoDeterminedLocation
• adminSpecifiedLocation

The POST and DELETE API calls are used to set, or delete the adminSpecifiedLocation information set for a device.

Monitoring > Devices

This API is used to fetch the list of devices associated with the given tenant or site.

To filter the list, you must use ODATA 4.0 filter format.
ODATA 4.0 filter example: filter=siteId eq 'site123' and status eq 'ONLINE'.

This API is used to fetch a list of network devices, such as Access Points, Switches, and Gateways from the device inventory. Each device in the returned list includes details like serial number, MAC address, device name, device type, IP address, status, etc.

Monitoring > Firewall Session

The firewall session monitoring API allows you to retrieve firewall session logs from a site.

This API is used to fetch the information about the blocked or denied firewall sessions logs from access points and gateways in a site.

This API is used to fetch the information of the firewall sessions logs. The logs are from access points and/or gateways deployed to a site based on the given filter parameters.

This API is used to fetch the list of clients from access points and/or gateways in a site based on the filter given.

Monitoring > FloorPlan

FloorPlan APIs are location service APIs. These APIs helps you to get information of devices associated to a site.

This API is used to fetch the non-associated and non-deployed device count for a site and the specific floor.

The API is used to fetch a list of placed devices on the FloorPlan. Currently, geoMetry is not supported; only x and y are returned in meters in geoMetryRelative.

The OData 4.0 filter must contain at least floorId or buildingId. Other supported parameters are types, name, model, etc.

The API is used to place devices on a FloorPlan for a specific floorId. The device must be assigned to floor before placing or deploying the device to the FloorPlan.

The API is used to remove a device from the FloorPlan.

The device is still assigned to the floor even after removing the device from the FloorPlan.

The API is used to assign and unassign devices to the floor. Only unassigned devices can be assigned to a floor.

The API is used to fetch devices information that are assigned to the floor. Devices that are placed on the floor are not included.

These APIs are used to fetch, place, modify, or delete planned devices on the FloorPlan for a specific floorID.

Devices which are placed on the floor have location coordinates (x,y). On executing the GET call, the x and y coordinates are returned in meters.

This API is used to fetch the list of Real device (AP) information for planning.

The API is used to create a new floor with FloorMapInput information. Optionally, pass buildingId to create a floor under a specific building.

These APIs are used to fetch, modify, or delete floor map information for the given floorID.

The PUT API call is also used to support moving floor from one building to another.

After deleting a floor if the building has no other floors, then the building is also removed.

The API is used to update the floor map with measurement information. AnchorGeometry uses 2 ways to measure the floor point and distance. To scale the floor, at least one of input must be available.

The API is used to update floorImage. After the API call, you must use the scale API call POST /network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/scale, to update floor measurement with respective to the new image.

The GET call is used to fetch the background raster image of a given floor.

The API is used to fetch the building and floor information created for a given site.

These APIs are used to update or delete the building using the building-id.

On deleting a building all floors and floor entities such as devices, walls, region, boundary are removed.

The API is used to import FloorPlans from Central, Airwave, or third party like Ekahau. The supported file formats are ZIP and ESX files.

The API is used to fetch the status information of the FloorPlan import process. It displays if the current import process completed successfully or not.

These APIs are used to fetch, create, modify, or delete wall types based on the inputs parameters and return the status of the operation.

These APIs are used to fetch, create, modify, or delete wall based on the inputs parameters.

These APIs are used to fetch, create, modify, or delete zones for a floor.

The API is used to fetch the signal strength heatmap for a given floor. The heatmap is calculated based on the band selection and floor selection.

The API is used to fetch the =channel occupancy heatmap for a given floor. The heatmap is calculated based on the signal cutoff, band selection, and channel overlap flag.

Monitoring > Open Locate

FTM stands for Fine Timing Measurement. AP FTM Scan Mode allows all APs on a particular floor to gather FTM ranging results from each other. During the scan, it disables all radios and puts them in a special mode where they will only perform FTM ranging attempts to other HPE Aruba Networking APs.

This API is used to fetch a list of scan statuses for FTM scans that were triggered on this floor-id before the query-time.

This API is used to get information for a specific FTM scan identified by the ftm-scan-id.

This API is used to start the FTM scan on a certain floor.

This API is used to stop an FTM scan with a specific session-id.

Only scans in the PENDING state can successfully be stopped. Once a scan has transitioned to the SCHEDULED, or SCANNING states the user needs to wait for the scan to complete before the network is restored.

Monitoring > Switch

This API is used to fetch switch information for a specific serial number for a specific site.

This API is used to fetch stack member details for a stack-id for a specific site.

This API is used to fetch hardware details for a switch serial number for a specific site.

This API is used to fetch the lag summary details for a serial for a specific site.

Monitoring > Gateways

This API is used to fetch a list of Gateways associated with a customer, based on the query parameters. The response body displays comprehensive details about the gateway such as serial number, name, MAC address, siteId, status, etc.