API Change Log in May 2025

Monitoring > Access Points

This API is used to fetch a list of radios associated to an access point. The response body includes comprehensive details like MAC address, band, status, and its current statistics for each radio in the list.

This API is used to fetch a list of ports associated to an access point. The response includes comprehensive details like MAC address, port index, and status for each port in the list.

This API is used to fetch a list of WLANs associated to an access point. The response includes WLAN name and security type for each WLAN in the list.

This API is used to fetch a list of tunnels associated with a specific access point, based on the provided query parameters.

This API is used to fetch detailed information about tunnels associated with a specific access point. It provides tunnel-related details such as name, status, encapsulation type, source, and destination information based on the access point’s serial number.

This API is used to fetch information about throughput trend data for a specific tunnel of an access point, including transmitted and received data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

This API is used to fetch information about packet loss trend data for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

This API is used to fetch information about jitter trend data for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

This API is used to fetch information about latency trend data for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

This API is used to fetch information about MOS score trend data for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.

Monitoring > Devices

Security > AAA Captive Portal

The GET API call is used to fetch the list of all external captive portal profiles for guest users.

These APIs are used to fetch, create, or update the parameters related to an external captive portal profile.

The delete API is used to delete the external captive profile.

Security > Aaa Dot1xsupp

This API is used to fetch the list of all configured 802.1X supplicant profiles.

These APIs are used to fetch, create, configure, or delete a specific 802.1X supplicant profile.

System > AP System

The GET API call is used to fetch the list of all configured AP system profiles.

These APIs are used to fetch, create, configure, update, or delete a specific AP system profile.

Interfaces > AP Port Profile

This API is used to fetch the list of all existing AP port profiles. The port profiles configuration parameters include VLAN settings, authentication methods, link speed, PoE settings, etc.

These APIs are used to fetch, create, update, or delete parameters related to a specific AP port profile.

VLAN & Networks > Named VLAN

This API is used to fetch the list of named-VLAN or VLAN-Group profiles and the configured parameters.

These APIs are used to fetch, create, update, or delete parameters related to a specific named-VLAN or VLAN-Group profiles. List of VLAN IDs can be added to a named-vlan profile.

Named Object > Aliases

This API is used to fetch the list of all configured aliases profiles.

These APIs are used to fetch, create, update, or delete the parameters related to the specified aliases profile. For POST API calls, the behavior of the alias gets updated instead of replaced.

Named Object > Net Service

This API is used to fetch the list of all configured net services.

These APIs are used to fetch, create, update, or delete parameters related to specific net services configured.

If Null is entered as a parameter value, then the parameter is deleted.

Roles & Policy > Policy Group

This API is used to fetch, create, update, or delete the list of all configured policy group container.

Roles & Policy > Policy

These APIs are used to fetch, create, or update the list of all configured policies.

These APIs are used to fetch, create, update, or delete the parameters related to a specific policy name.

If Null is entered as a parameter value, then the parameter is deleted.

Roles & Policy > Role Gpid

This API is used to fetch the list of all the configured role and its associated GPID.

These APIs are used to fetch, create, update, or delete the parameters related to a specific role and GPID.

Roles & Policy > Roles

This API is used to fetch the list of roles configured. Role is a feature that allows administrators to assign network access to clients. The network admin can create configuration profiles(roles), associate them to clients and configure various parameters of role that are supported.

These APIs are used to fetch, create, update, or delete the parameters related to a specific role name.

Scope Management > Sites

These APIs are used to fetch, create, replace, or delete a site.

On successful site creation, the response body displays the scope id of the newly created site.

The GET call supports the following options:

• Search—Partial or full string free text search.

• Sort—To sort a field based on ascending or descending order, use ASC or DESC keywords respectively. The sort option is supported on the following fields:

  • scopeName

  • address

  • state

  • country

  • city

  • deviceCount

  • collectionName

  • zipcode

  • timezone

  • latitude

  • longitude

  For example, sort=deviceCount DESC.

• Filter—To filter the list, you must use the ODATA 4.0 filter format. The filter option is supported on the following fields:

  • scopeName

  • address

  • city

  • state

  • country

  • zipcode

  • collectionName

  For example, filter=country eq 'India' and city in ('Bengaluru','Chennai')

Scope Management > Site Collections

These APIs are used to fetch, create, update, or delete a site collection. The site collection can be created with or without sites in the request body.

This GET API call is used to fetch the list of all site collections and supports the following options:

• Search—Partial or full string free text search.

• Sort—To sort a field based on ascending or descending order, use ASC or DESC keywords respectively. The sort option is supported on the following parameters:

  • scopeName

  • description

  • deviceCount

  • siteCount

• Filter—To filter the list you must use the ODATA 4.0 filter format. The filter option is supported on the following fields:

  • scopeName

  • description

This API is used to add one or more available sites to existing site collection.

This API is used to remove one or more available sites to existing site collection.

Scope Management > Device Collections

The GET API call is used to fetch a list of devices-groups with its properties.

Scope Management > Hierarchy

The API is used to fetch the hierarchy of given scopeId and its scopeType.

Security > 802dot11k Bcn Rpt Req

This API is used to fetch the list of Beacon Report Request profiles.

These APIs are used to fetch, create, update, or delete the parameters related to a specific Beacon Report Request profile.

Security > 802dot11k Rrm Ie

This API is used to fetch the list of Radio Resource Management (RRM) IE profile.

The Radio Resource Management (RRM) Information Element (IE) is essential for optimizing radio resource allocation in wireless networks. It enhances network performance by managing resources efficiently and ensuring quality of service.

These APIs are used to fetch, create, or update parameters related to a specific RRM IE profile.

Security > 802dot11k

This API is used to fetch the list of all 802.11k radio profiles.

The 802.11k protocol provides mechanisms for APs and clients to dynamically measure the available radio resources. In an 802.11k enabled network, APs and clients can send neighbor reports, beacon reports, and link measurement reports to each other.

These APIs are used to fetch, create, or update parameters related to a specific 802.11k radio profile.

Security > Server Groups

This API is used to fetch the list of all authentication server groups and the server group configurations.

These APIs are used to fetch, create, update, or delete the parameters related to a specific authentication server group.

Security > Auth Server

This API is used to fetch the list of all Auth Servers along with the configured parameters.

These APIs are used to fetch, create, update, or delete parameters to configure a specific authentication server profile.

Security > EST

This API is used to fetch the list of all configured EST profiles along with the configured parameters. Enrollment over Secure Transport (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. The APIs enables the user to have maximum visibility and control over the management of the PKI used and address any issues related to security by themselves in a scaled environment. This feature is applicable for all devices.

These APIs are used to fetch, create, update, or delete a specific EST profile.

Security > Firewall

This API is used to fetch the list of all the configured firewall profiles.

These APIs are used to fetch, create, update, or delete parameters related to a specific firewall profile.

Extensions > Extension Vsphere

This API is used to fetch list of all configured vSphere instances.

These APIs are used to fetch, create, update, or delete parameters related to a specific vSphere Extension-installed instance.

Security > Custom Get Api

This API is used to fetch the customized APIs.

System > Ddns Http

This API is used to fetch the list of all configured Dynamic DNS (DDNS) profiles supporting proprietary protocols over HTTP(S).

This API is used to fetch, create, update, or delete the parameters related to a specific Dynamic DNS (DDNS) profile that supports proprietary protocols over HTTP(S).

System > Ddns

This API is used to fetch the list of all configured global Dynamic DNS profile parameters for IETF supported servers.

These APIs are used to fetch, configure, update, or delete the parameters related to a specified global Dynamic DNS profile that supports the IETF protocol.

System > Ddns

This API is used to fetch the list of DNS profiles along with the configured DNS parameters. The DNS parameters include domain name, DNS resolver, DNS redirect, and DNS static host configurations.

This API is used to fetch, create, update, or delete the DNS parameters for a specific global profile.

System > Http Proxy

This API is used to fetch the list of all configured HTTP proxy server profile. On AP, the HTTP proxy settings are to download the image from the cloud server, or route the web classification queries through the proxy server. On AOS-CX and AOS-S switches, the HTTP proxy configuration is utilized to connect to activate server and Classic Central.

These APIs are used to fetch, create, update, or delete the parameters related to a specific HTTP proxy server profile.

System > IPM

This API is used to fetch the list of all the configured Intelligent Power Monitoring (IPM) profiles.

These API are used to fetch, create, update, or deleted parameters related to the configuration of specific IPM profile.

System > Logging

This API is used to fetch the list of all configured logged profiles along with the parameters.

This API is used to fetch, create, update, or delete the parameters related to a specific logging profile by name.

System > Management Users

This API is used to fetch, create, or update the list of all the configured management users with role and authorization.

These APIs are used to fetch, create, update, or delete the parameters configuration for a specific management user role.

System > NTP

This API is used to fetch the list of global profiles configured with NTP parameters.

These APIs are used to fetch, create, update, or delete parameters related to an NTP profile.

System > Scopemap

This API is used to fetch the configure scope mapping for resources. Configuration resources may be applied within a specific context, identified by a scope and a persona.

These APIs are used to fetch, create, update, or delete a specific scope maps.

These APIs are supported only if the parameter values defined while creating a scope-map matches.

System > Snmp

This API is used to fetch the list of configured SNMP profiles.

These API is used to fetch, create, update, or delete parameters related to a specific SNMP profile.

System > Speed Test

This API is used to fetch the list of all configured speed test profiles.

These APIs are used to fetch, create, update, or delete the parameters related to a specific speed test profile.

System > Switch System

This API is used to fetch the list of all configured switch system profiles.

This API is used to fetch, create, update, or delete a specific switch system profiles and switch system profile attributes.

System > Timerange

This API is used to fetch the list of all configured time range profiles along with the profile parameters.

These APIs are used to fetch, create, update, or delete a specific time range profile.

Wireless > Alg

This API is used to fetch list of all configured ALG profiles along with the ALG profile parameters.

These APIs are used to fetch, create, update, or delete parameters related to global ALG profile.

Wireless > Mesh

This API is used to fetch, create, or update the list all configured mesh profiles along with the profile parameters.

These APIs are used to fetch, create, update, or delete a mesh profile.

Wireless > Radio

This API is used to fetch the list of all configured radio profiles along with profile parameters.

The wireless access point broadcasts the network over radio frequency (RF) signals which wireless clients connect to. Radio configuration involves setting up and optimizing the various parameters of the AP radio to ensure efficient and reliable wireless communication.

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

Wireless > WLAN

This API is used to fetch the list of all configured WLAN SSID profiles along with the profile parameters.

New parameters are added to APIs listed under Monitoring > Access Points.

• SiteName—Displays the name of the site where the device is located. This name is used to identify and manage devices based on their physical location, allowing for better organization and tracking.

• ClusterName—Displays the name of the cluster to which the device belongs. If the device is not associated with any cluster, the cluster name will be null.

• Three new parameters bandwidth, channel, and power are added under the Radios payload.

Scope Management