API Change Log in November 2025

This topic lists the APIs updated in this release.

New MRT APIs

Table 1: New MRT APIs

Method

Path

Description

Monitoring > Site Health

GET

/network-monitoring/v1alpha1/sites-client-experience

This API is used to fetch the list of sites with the number of poor, fair, and good performing clients for each site.

GET

/network-monitoring/v1alpha1/tenant-client-experience

This API is used to fetch information about the health overview of clients categorized as poor, fair, or good performing.

Monitoring > Access Points

GET

 /network-monitoring/v1alpha1/top-aps-by-wired-usage

This API is used to fetch a list of the top access points ranked by their wired bandwidth usage, sorted in descending order, for a specified site and time period.

GET

 /network-monitoring/v1alpha1/top-aps-by-usage

This API is used to fetch a list of the top access points ranked by total wired and wireless bandwidth usage, sorted in descending order for the given site and time.

Monitoring > Gateways

GET

/network-monitoring/v1alpha1/gateways/{serial-number}/dhcp_pools

This API is used to fetch the DHCP pool list for the specified gateway.

GET

/network-monitoring/v1alpha1/gateways/{serial-number}/dhcp_clients

This API is used to fetch the list of DHCP leases present in the DHCP pool.

Notification > Alerts

GET

/network-notifications/v1alpha1/alerts

This API is used to fetch information about the alerts for a specific siteId.

Services > Audit Trail Information

GET

/network-services/v1alpha1/audit

This API is used to fetch information about all the audit logs based on the tenants.

GET

/network-services/v1alpha1/audit/{id}

This API is used to fetch information about the audit log entry for a given audit ID.

Services > WIDS

GET

/network-services/v1alpha1/wids-intrusions

This API is used to fetch information about the wireless security events and intrusion alerts detected by the WIDS (Wireless Intrusion Detection System) system.

GET

/network-services/v1alpha1/wids-monitored-aps

This API is used to fetch information about the wireless access points detected and monitored by the WIDS (Wireless Intrusion Detection System).

Troubleshooting > Events

GET

/network-troubleshooting/v1alpha1/events

This API is used to fetch a list of Network Events, based on the query parameters provided. Each Event in the returned list includes details like event name, category, source type, severity, etc.

GET

/network-troubleshooting/v1alpha1/event-extra-attributes

This API is used to fetch extra attributes of the event. The response includes event attributes as key-value pairs.

GET

/network-troubleshooting/v1alpha1/event-filters

This API is used to fetch the available filter options for network events, including categories, source types, and event names with their respective counts. The retrieved information can be used to refine the results returned by the List Events (GET /network-troubleshooting/v1alpha1/events) API.

Troubleshooting > Access Points
POST /network-troubleshooting/v1alpha1/aps/{conductor-serial}/rebootSwarm This API is used to start a reboot operation on the entire Swarm, triggered via its current conductor AP. The {conductor-serial} must be the serial of the Swarm's active conductor.
GET /network-troubleshooting/v1alpha1/aps/{serial-number}/list-tasks This API is used to fetch a list of all active or recently completed asynchronous operations for the specified AP, grouped by test name.

Troubleshooting > CX Switches
GET /network-troubleshooting/v1alpha1/cx/{serial-number}/list-tasks This API is used to fetch a list of all active or recently completed asynchronous operations for the specified CX Switch, grouped by test name.

Troubleshooting > AOS-S Switches
GET /network-troubleshooting/v1alpha1/aos-s/{serial-number}/list-tasks This API is used to fetch a list of all active or recently completed asynchronous operations for the specified AOS-S Switch, grouped by test name.

Troubleshooting > Gateways
GET /network-troubleshooting/v1alpha1/gateways/{serial-number}/list-task This API is used to fetch a list of all active or recently completed asynchronous operations for the specified gateway, groups by test name.

New Configuration APIs

Table 2: New Configuration APIs

Method

Path

Description

Services > Location

GET

/network-config/v1alpha1/location

This API is used to fetch the location configuration.

It supports three methods for locating:

  • Received Signal Strength Indication (RSSI)
  • Analytics and Location Engine (ALE)
  • Real Time Location System (RTLS)

GET, POST, PATCH, or Delete

/network-config/v1alpha1/location/{name}

These APIs are used to fetch, create, update, or delete the location information of a specific location profile name.

Security > Est

GET

/network-config/v1alpha1/est-profiles

This API is used to fetch the list of all configured Enrollment over Secure Transport (EST) profiles.

EST supports automatic enrollment of certificates with the EST Server. The certificates can be enrolled or re-enrolled automatically by configuring an EST profile on the device. Certificate Enrollment with EST allows users to use their own PKI instead of the factory or self-signed certificates available on the Instant AP.

GET, POST, PATCH, or DELETE

/network-config/v1alpha1/est-profiles/{name}

These APIs are used to fetch, create, update, or delete the parameters related to the specified EST profile.

Modified APIs

MRT APIs

Table 3: Modified MRT APIs

Method

Description

Monitoring > Access Points

[GET] /network-monitoring/v1alpha1/aps/{serial-number}/tunnels

In the query parameter, the SiteID parameter is updated to site-id.

[GET] /network-monitoring/v1alpha1/aps/{serial-number}

The API is modified to include site-id in the request. The site-id is an optional parameter.

Monitoring > Gateways

The tunnel-id parameter is updated to tunnel-name for the APIs listed under Monitoring > Gateways.

Services > Location

[POST] /network-services/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/start

The Start an AP Ranging Scan API is updated with the following changes:

  • Added support for a DRY_RUN option to get the estimated completion time before triggering a scan

  • Added the estimatedCompletionTime and serialNumbers parameters to the response body.

The following API path listed under Service > Location are updated:

Old API path

New API path

[GET] /network-services/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans

[GET] /network-services/v1alpha2/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans

[GET] /network-services/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/{scan-id}

[GET] /network-services/v1alpha2/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/{scan-id}

[GET] /network-services/v1alpha1/sites/{site-id}/device-locations

[GET] /network-services/v1alpha2/sites/{site-id}/device-locations

[GET] /network-services/v1alpha1/sites/{site-id}/device-locations/{location-id}

[GET] /network-services/v1alpha2/sites/{site-id}/device-locations/{location-id}

[GET] /network-services/v1alpha1/sites/{site-id}/devices/{serial-number}/location

[GET] /network-services/v1alpha2/sites/{site-id}/devices/{serial-number}/location

[GET] /network-services/v1alpha1/sites/{site-id}/devices/{serial-number}/location

[GET] /network-services/v1alpha2/sites/{site-id}/devices/{serial-number}/location

Configuration APIs

Table 4: Modified Configuration APIs

Method

Description

Named Object > Alias

The APIs listed under Alias are updated to support the following enhancements:

  • The ALIAS_DNS_RESOLVER, ALIAS_GW_PORT_PROFILE_SWITCHPORT, and ALIAS_IPV4_ADDRESS_TYPE types are supported for gateways.

  • The ALIAS_IPV4_ADDRESS_TYPE parameter supports Static IP, DHCP, or PPPoE address types for gateways.

  • A new parameter gw-switchport-value has been added to the default-value list.

System > DNS

The list of DNS APIs now supports DNS profile with alias.

VLANs & Networks > VLAN

The description-alias parameters listed under the VLAN APIs now support the gateway device type. You must use the alias name for the description-alias field.

System > SNMP

The APIs listed under SNMP now support the gateway device type.

System > Switch Systems

The following parameters are added to the APIs listed under Switch System:

  • ICMP

  • TCP

The Airgroup Service Definition, Airgroup System, and Airgroup Policy APIs that were listed under Application Experience are moved under Services.

Removed APIs

Table 5: Removed APIs

Method

Description

System > Ip Icmp Tcp

The APIs listed under Ip Icmp Tcp are removed.

To configure ICMP and TCP parameters, use the System > Switch System APIs.