API Change Log in September 2025
This topic lists the APIs updated in this release.
New MRT APIs
|
Method |
Path |
Description |
|---|---|---|
|
Services > Location |
||
|
POST |
/network-services/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/start |
This API is used to start an AP ranging scan for the given floor-id. AP ranging scans facilitate using automatic AP placement within the Floorplan manager as it allows the system to collect inter-AP ranging information in a shorter time frame. |
|
GET |
/network-services/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans |
This API is used to fetch the list of scan statuses for AP ranging scans that were initiated on a specific floor-id before the query-time. |
|
GET |
/network-services/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/{scan-id} |
This API is used to fetch the status of the AP ranging scan for the specified scan-id. |
|
GET |
/network-services/v1alpha1/wifi-clients-locations |
This API is used to fetch the Wi-Fi client locations. You must use either latest-location-per-client or last-connect-client-mac-address query parameters. |
|
GET |
/network-services/v1alpha1/asset-tags |
This API is used to fetch a list of assets with location and metadata based on filters. |
|
GET |
/network-services/v1alpha1/asset-tags/{asset-tag-id} |
This API is used to fetch detailed information about a specific asset. |
|
POST, PUT, and DELETE |
/network-services/v1alpha1/asset-tags/{asset-tag-id}/metadata |
This API is used to add, modify, or delete the metadata parameters for the specified asset. Note:
The API call does not modify the asset tag image. |
|
Troubleshooting > Access Points |
||
|
GET |
/network-troubleshooting/v1alpha1/aps/{serial-number}/show-commands |
This API is used to fetch the most commonly used or top show commands supported on a specified AP. |
|
POST |
/network-troubleshooting/v1alpha1/aps/{serial-number}/showCommand |
This API is used to initiate an asynchronous show command test on a specified AP. |
|
GET |
/network-troubleshooting/v1alpha1/aps/{serial-number}/showCommand/async-operations/{task-id} |
This API is used to fetch the result of the asynchronous show command test on a specified AP. |
|
Troubleshooting > AOS-S Switches |
||
|
GET |
/network-troubleshooting/v1alpha1/aso-s/{serial-number}/show-commands |
This API is used to fetch the most commonly used or top show commands supported on a specified AOS-S switch. |
|
POST |
/network-troubleshooting/v1alpha1/aso-s/{serial-number}/showCommand |
This API is used to initiate an asynchronous show command test on a specified AOS-S switch. |
|
GET |
/network-troubleshooting/v1alpha1/aso-s/{serial-number}/showCommand/async-operations/{task-id} |
This API is used to fetch the result of the asynchronous show command test on a specified AOS-S switch. |
|
Troubleshooting > CX Switches |
||
|
GET |
/network-troubleshooting/v1alpha1/cx/{serial-number}/show-commands |
This API is used to fetch the most commonly used or top show commands supported on a specified AOS-CX switch. |
|
POST |
/network-troubleshooting/v1alpha1/cx/{serial-number}/showCommand |
This API is used to initiate an asynchronous show command test on a specified AOS-CX switch. |
|
GET |
/network-troubleshooting/v1alpha1/cx/{serial-number}/showCommand/async-operations/{task-id} |
This API is used to fetch the result of the asynchronous show command test on a specified AOS-CX switch. |
|
Troubleshooting > Gateways |
||
|
GET |
/network-troubleshooting/v1alpha1/gateways/{serial-number}/show-commands |
This API is used to fetch the most commonly used or top show commands supported on a specified gateway. |
|
POST |
/network-troubleshooting/v1alpha1/gateways/{serial-number}/showCommand |
This API is used to initiate an asynchronous show command test on a specified gateway. |
|
GET |
/network-troubleshooting/v1alpha1/gateways/{serial-number}/showCommand/async-operations/{task-id} |
This API is used to fetch the result of the asynchronous show command test on a specified gateway. |
|
Monitoring > Clients |
||
|
GET |
/network-monitoring/v1alpha1/clients/trends |
This API is used to fetch the client trends based on the specified group-by field and type category across a time range. |
|
Monitoring > Access Points |
||
|
GET |
/network-monitoring/v1alpha1/wlans |
This API is used to fetch a list of WLANs associated to a customer, based on the query parameters provided. Each WLAN in the returned list includes comprehensive details like name, security level, band, status, and VLAN configuration. |
|
GET |
/network-monitoring/v1alpha1/wlans/{wlan-name} |
This API is used to fetch the details of a specified WLAN |
|
Monitoring > Devices |
||
|
DELETE |
/network-monitoring/v1alpha1/devices/{serial-number} |
This API is used to delete a network device based on the serial number. |
|
Monitoring > GDPR |
||
|
GET |
/network-monitoring/v1alpha1/gdpr-exclusions |
This API is used to fetch the list of all exclusion records with optional filtering. |
|
POST |
/network-monitoring/v1alpha1/gdpr-exclusions |
This API is used to create a new GDPR exclusion record. |
|
GET |
/network-monitoring/v1alpha1/gdpr-exclusions/{exclusion-id} |
This API is used to fetch the details of a specific exclusion record by ID. |
|
DELETE |
/network-monitoring/v1alpha1/gdpr-exclusions/{exclusion-id} |
This API is used to delete a specific exclusion record by ID. |
|
GET |
/network-monitoring/v1alpha1/gdpr-exclusion-types |
This API is used to fetch the list of all available exclusion types with their validation rules. |
|
GET |
/network-monitoring/v1alpha1/gdpr-exclusion-types/{exclusion-type-id} |
This API is used to fetch the details of a specific exclusion type by its ID. |
|
Monitoring > Gateways |
||
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/uplinks/{link-tag}/aggregated-usage |
This API is used to fetch the bandwidth usage (in bytes) for a specified gateway uplink, based on the timestamp range provided in the filter. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/ports/{port-number}/aggregated-usage |
This API is used to fetch the bandwidth usage (in bytes) for a specified gateway port, based on the timestamp range provided in the filter. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/lan-tunnels/{tunnel-name}/aggregated-usage |
This API is used to fetch the bandwidth usage (in bytes) for a specified gateway LAN tunnel, based on the timestamp range provided in the filter. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels/{tunnel-name}/aggregated-usage |
This API is used to fetch the bandwidth usage (in bytes) for a specified gateway WAN tunnel, based on the timestamp range provided in the filter. |
|
GET |
/network-monitoring/v1alpha1/gateways/{serial-number}/uplinks |
This API retrieves the list of WAN interfaces on a gateway, including details such as link tag, status, public IP address, and other attributes. |
Modified APIs
|
Method |
Description |
|---|---|
|
Monitoring > Firewall Session AOS-CX switches support the list of APIs listed under Firewall Session. |
|
|
Monitoring > Gateways |
|
|
[GET] /network-monitoring/v1alpha1/gateways/{serial-number} [GET] /network-monitoring/v1alpha1/gateways/{serial-number}/vlans/{vlan-id} [GET] /network-monitoring/v1alpha1/gateways/{serial-number}/tunnels/lan/{tunnel-name}/detail [GET] / network-monitoring/v1alpha1/gateways/{serial-number}/interfaces [GET] /network-monitoring/v1alpha1/gateways/{serial-number}/vlans [GET] /network-monitoring/v1alpha1/gateways/{serial-number}/lan-tunne [GET] network-monitoring/v1alpha1/gateways/{serial-number}/wan-interfaces [GET] network-monitoring/v1alpha1/gateways/{serial-number}/lan-tunnels-health-summary [GET] network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels [GET] network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels/{tunnel-name} [GET] network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels-health-summary [GET] network-monitoring/v1alpha1/gateways/{serial-number}/wan-interfaces/{link-tag} |
The siteId parameter is removed from the filter parameters. |
Deprecated APIs
|
Alternate APIs |
|
|---|---|
|
All the APIs listed under Monitoring > Device Location are moved to Services > Location. |
|
|
[GET] /network-monitoring/v1alpha2/sites/{site-id}/device-locations |
[GET] /network-services/v1alpha1/sites/{site-id}/device-locations |
|
[GET] /network-monitoring/v1alpha2/sites/{site-id}/device-locations/{location-id} |
[GET] /network-services/v1alpha1/sites/{site-id}/device-locations/{location-id} |
|
[GET] /network-monitoring/v1alpha2/sites/{site-id}/devices/{serial-number}/location |
[GET] /network-services/v1alpha1/sites/{site-id}/devices/{serial-number}/location |
|
[POST] /network-monitoring/v1alpha2/sites/{site-id}/devices/{serial-number}/location |
[POST] /network-services/v1alpha1/sites/{site-id}/devices/{serial-number}/location |
|
[DELETE] /network-monitoring/v1alpha2/sites/{site-id}/devices/{serial-number}/location |
[DELETE] /network-services/v1alpha1/sites/{site-id}/devices/{serial-number}/location
|
|
APIs listed under Monitoring > Location Services is moved to Services > Location, and the API path is updated. |
|
|
[GET] /network-monitoring/v1alpha1/wifi-clients-locations |
[GET] /network-services/v1alpha1/wifi-clients-locations
|
|
Configuration > Scope Management > Sites |
|
|
[DELETE] /network-config/v1alpha1/sites |
[DELETE] /network-config/v1alpha1/sites/bulk |
|
Configuration > Scope Management > Site Collections |
|
|
[DELETE] /network-config/v1alpha1/site-collections |
[DELETE] /network-config/v1alpha1/site-collections/bulk |
|
Configuration > Scope Management > Device Groups |
|
|
[DELETE] /network-config/v1alpha1/device-collections |
[DELETE] /network-config/v1alpha1/device-groups/bulk |
Removed APIs
|
New APIs |
|
|---|---|
|
Monitoring > Open Locate |
|
|
[POST] /network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ftm-scans/start [GET] /network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ftm-scans [GET] /network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ftm-scans/{ftm-scan-id} [DELETE] /network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ftm-scans/{ftm-scan-id} |
Not Available |
|
Configuration > Scope Management > Device Collections |
|
|
The API listed under Scope Management > Device Collections is moved to Scope Management > Device Groups and the API path is update. |
|
|
Old API path [GET] /network-config/v1alpha1/device-collections |
New API path [GET] /network-config/v1alpha1/device-groups |