API Change Log in October 2025

Monitoring > Access Points

This API is used to fetch the list of swarms based on the query parameters. A swarm is a cluster of access points that operate together as a single system. Within the swarm, one AP automatically assumes the role of conductor (virtual controller) to manage configuration, firmware, and policies, while the other APs function as members to provide client connectivity.

This API is used to fetch the details of a specific swarm (cluster). It provides comprehensive swarm-related details such as cluster ID, cluster name, conductor information, site ID, IP addresses, member count, and software version based on the swarm's cluster ID.

Monitoring > Clients

This API is used to fetch the Top N client by usage across a time range.

Monitoring > Gateways

This API is used to fetch the hardware temperature trend data for the gateway based on specified timestamp range.

This API is used to fetch information about a specific LAN tunnel configured in the gateway.

This API is used to fetch the gateway LAN tunnel packet trends for the specified tunnel based on timestamp range.

This API is used to fetch the throughput trend data for a gateway WAN tunnel based on specified timestamp range.

This API is used to fetch the gateway WAN tunnel packet trends for the specified tunnel based on timestamp range.

Monitoring > Site Health

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

This API is used to fetch information about the list of tenant clients onboarded to a specific site.

Services > Firmware

This API is used to fetch the device firmware details such as software version, upgrade status, recommended version, firmware classification and last upgrade time.

Services > 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-services/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.

Troubleshooting > Gateways

The API is used to start an asynchronous PingSweep on a Gateway.

Application Experience > Airgroup System

These APIs are used to fetch, create, update, or DELETE the parameters related to AirGroup system configuration. These APIs are used to enable or disable the AirGroup system. The AirGroup system is configurable at all scope levels, with the exception of the device scope.

Application Experience > App Recog Control

These APIs are used to fetch the list of all configured Application Recognition & Control (ARC) global profile(s). These APIs are applicable to AP, Gateway & CX-Switch devices only.

These APIs are used to fetch, configure, update, or delete the parameters related to the specified Application Recognition & Control (ARC) profile.

Application Experience > UCC

These APIs are used to fetch the list of all configured AP UCC global profile(s).

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

Application Experience > Airgroup Policy

This API is used to fetch the list of all configured AirGroup policies.

These APIs are used to fetch, create, update, or delete the specified AirGroup policy. A policy must include a service definition, while VLANs and roles are optional. In VLANs, both allowed-vlans and disallowed-vlans cannot be configured simultaneously. A maximum of 20 VLANs or VLAN ranges can be configured.

The AirGroup policy is configurable at all scope levels, with the exception of the device scope.

Application Experience > Airgroup Service Definition

This API is used to fetch the list of all standard and custom AirGroup services configured.

The list of standard services are:

• AirPlay
• AirPrint
• Amazon TV
• Google Cast
• DIAL
• DLNA Media
• DLNA Print

Central NAC > CDA Authz Policy

This API is used to fetch the list of all configured authorization policies to be used for Central NAC.

These APIs allow you to fetch, create, update, or delete parameters related to specific Central NAC authorization policy.

Central NAC > CDA AirPass Approval

This API is used to fetch the list of all Air Pass profile configurations.

This API is used to fetch the configurations for a specific Air Pass profile.

Central NAC > CDA Identity Store

This API is used to fetch the list of all configured identity stores that are available for Central NAC. These stores can be configured for Identity providers like Azure, Microsoft, Okta, and local user or MAC-based stores.

They can be referenced in authentication profiles and authorization policies and used for authentication and authorization. Identity stores must be configured with default query parameters.

These APIs allow you to fetch, create, update, or delete parameters related to specific identity stores that are available for Central NAC.

Central NAC > CDA Portal Profile

This API is used to fetch the list of all configured portal profiles available for Central NAC.

These APIs allow you to fetch, create, update, or delete parameters related to specific portal profiles configured for Central NAC.

Central NAC > CDA Auth Profile

This API is used to fetch the list of all configured authentication profiles available for Central NAC.

Authentication profile defines the authentication method, authentication sources, and other attributes used to authenticate users on the associated networks. Authentication profiles must be configured with default query parameters.

These APIs allow you to fetch, create, update, or delete parameters related to specific authentication profile configured for Central NAC.

Central NAC > CDA Portal Skin Profile

This API is used to fetch the list of all portal skins that contain page-level layout and presentation configured for Central NAC portals.

These APIs allow you to fetch, create, update, or delete parameters related to specific portal skins for Central NAC.

Central NAC > CDA Message Provider

This API is used to fetch the list of messaging service providers to use with Central NAC.

These APIs allow you to fetch, create, update, or delete parameters related to specific messaging service provider used with Central NAC.

Central NAC > CDA Portal Overrides Profile

This API is used to fetch the list of portal overrides that contain multilingual text overrides applied to Central NAC portals.

Central NAC Service > MAC Registration

The GET API call is used to fetch the list of MAC registrations.

The POST and PATCH API calls are used to add, and update the MAC address to allow network access.

This API call is used to delete a MAC registration.

This API call is used to export the MAC CSV file from Central NAC.

This API call is used to import MAC CSV file into Central NAC.

Central NAC Service > MPSK Registration

The GET API call is used to fetch the list of Named MPSK registrations.

The POST and PATCH API calls are used to add, and update the Named MPSK configuration to allow network access.

This API call is used to delete a Named MPSK registration.

This API call is used to export the Named MPSK CSV file from Central NAC.

This API call is used to import Named MPSK CSV file into Central NAC.

Central NAC Service > Visitor

The GET API call is used to fetch the list of visitor accounts.

The POST and PATCH API calls are used to create and update the visitor account.

This API call is used to delete a visitor account.

This API call is used to export the visitor CSV file from Central NAC.

Central NAC Service > Job

This API is used to fetch the list of import, or export jobs with optional filters.

These APIs are used to download or terminate an import or export job.

This API is used to download the error file from a prior import operation.

This API is used to download the input file from a prior import operation.

This API is used to fetch details of an import or export operation based on job id.

Central NAC Service > Image

This API is used to fetch the list of all uploaded images.

This API is used to download an image from Central NAC.

This API is used to upload an image to Central NAC. This image can be used to customize Web Portals. Maximum size is 5MB.

This API is used to fetch the metadata of an uploaded image

Central NAC Service > User Certificate

This API is used to fetch the list of all user certificates based on the User Principal Name (UPN).

Config Management > Config Checkpoint

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

Configuration Health > Configuration Health

This API is used to fetch active configuration issues for a device.

Extensions > Extension vSphere

This API is used to fetch the list of all installed vSphere extension instances.

High Availability > Switch Stack

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

These APIs are used to fetch, create, update, or delete parameters related to a specified stack.

High Availability > VSX

This API is used to fetch the list of Virtual Switching Extension (VSX) profiles configured.

If the role selection is set to automatic, then the primary switch is selected based on the following:

• If the peer switches are of the same switch model, then the switch with the lowest MAC address is selected as the primary switch.

• If the peer switches are of different switch model, then the switch with the highest MAC address is selected as the primary switch.

Interface > Device Profile

This API is used to fetch the list of all configured device profiles. The device profile allows automatic discovery and configuration of devices such as APs, IP phones, Security cameras, Printers, and other attributes. On the network. The discovery is done via LLDP, CDP, or MAC match.

Interface Security > MAC Lockout

This API is used to fetch the list of all configured MAC lockout profile.

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

Interface Security > MACSec

This API is used to fetch the list of all configured MACsec policies.

Interfaces > Interface Loopback

This API is used to fetch the list of all the configured loopback interface.

These APIs are used to fetch, create, update, or delete the parameters related to a specific loopback interface. Each device type has its own capacity defined for the number of interfaces and addresses it can support.

Interfaces > Interface Management

This API is used to fetch the list of management interface profiles. The device is configured and monitored through the management interface on the mgmt VRF, which handles all management traffic such as SSH, SNMP, TFTP, and similar services.

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

Interfaces > UFD

This API is used to fetch the list of profiles for Uplink Failure Detection.

These APIs are used to fetch, create, update, or delete the parameters related to the specified profile for Uplink Failure Detection.

Interfaces > Fault Monitor

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

These APIs are used to fetch, create, update, or delete parameters related to a specified fault monitor profile.

Interfaces > AP Uplink

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

These APIs are used to fetch, create, update, or delete the parameters related to the specified AP uplink profile. Configure the uplink parameters, such as Ethernet uplink, cellular uplink, preemption parameters, management VLAN for the specified AP system profile.

Interfaces > sFlow

This API is used to fetch the list of all global Sampled Flow (sFlow) profiles. The sFlow is an industry-standard sampling technology used to sample application-level packet flows and gather interface statistics from network devices.

These APIs are used to fetch, create, update, or delete the parameters related to the specified Sampled Flow (sFlow) profile.

Interfaces > Interface Subinterface

This API is used to fetch the list of all Sub-Interfaces configured.

These APIs are used to fetch, create, update, or delete the parameters related to the specified Sub-Interfaces.

Interfaces > LLDP

This API is used to fetch the list of all configured Link Layer Discovery Protocol (LLDP) profiles.

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

Interfaces > SW Port Profile

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

A port profile is a template for configuring Ethernet interface configurations. It is a mechanism intended to ease the process of configuring multiple interfaces with same set of configurations.

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

Interfaces > Interface VLAN

This API is used to fetch the list of all Layer 3 VLAN (Virtual Local Area Network) configurations.

These APIs are used to fetch, create, update, or delete the parameters related to the specified Layer 3 VLAN.

Interfaces > Interface Port Channel

This API is used to fetch the list of all port channel interface configured.

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

Interfaces > CDP

This API is used to fetch the list of all configured Cisco Discovery Protocol (CDP) profile.

These APIs are used to fetch, create, update, or delete the parameters related to a specific CDP profile. CDP is used for collecting directly connected neighbor device information like hardware, software, device name details, etc.

Interfaces > DHCP Client

This API is used to fetch the list of all global profiles for DHCP Client Option configuration.

These APIs are used to fetch, create, update, or delete the parameters related to a specific DHCP Client Option configuration.

Interfaces > Interface Ethernet

This API is used to fetch the list of all the configured Ethernet interfaces.

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

Interfaces > LACP

These APIs are used to fetch, create, update, or delete the parameters related to LACP global configuration at the system level.

Interfaces > Interfaces Profile

This API is used to fetch the list of all configured interface profiles. Interface Profile is bundle of interface configuration for devices with specific SKU or model. Defined for set of uplink or downlink ports for a given model.

IoT > IoT

This API is used to fetch the list of all global profiles for IoT parameters including radio profile and transport profile.

The IoT function on an Access Point (AP) involves managing and facilitating communication between various IoT devices and the network. Including the configuration and maintenance of radio profiles, transport protocols, Zigbee services, and specific systems like SES-imagotag's Electronic Shelf Label (ESL) system.

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

IoT > USB

This API is used to fetch the list of all global profiles for USB parameters including the USB profile list and the ACL rule profiles detail.

Miscellaneous > Switch Profiles

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

System profiles set the overall capabilities and capacities of the switch, based on the selected profile used at boot time. System profiles set capacities such as the hardware forwarding table. System profiles provide you with the flexibility to configure switches based on their location in the network (for example, core, spine, leaf).

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

Miscellaneous > Mirror Endpoint

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

Mirror endpoints terminate a remote mirror tunnel. They serve to control packet decapsulation and forwarding to the mirror destinations. Creating a Mirror Endpoint is independent of the corresponding mirror session, which means there is no ordering requirement for the creation of a mirror session and a Mirror Endpoint.

These APIs are used to fetch, create, update, or delete parameters related to a specified global profile for mirror endpoint configuration.

Miscellaneous > Switch Chassis

This API is used to fetch the list of all switch chassis.

These APIs are used to fetch, create, update, or delete parameters related to specified switch chassis configurations.

Miscellaneous > Device Certificate

This API is used to fetch the list of all configured device certificate.

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

Miscellaneous > Extension Splunk

This API is used to fetch the list of all configured Splunk instances container profile.

These APIs are used to fetch, create, update, or delete the parameters related to the specified Splunk extension installed instances profile.

Miscellaneous > Packet Capture

This API is used to fetch the list of all configured packet capture defaults profiles.

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

Miscellaneous > Static Neighbor

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

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

Miscellaneous > Profile Operation

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

Miscellaneous > Device Info

This API is used to fetch the list of all configured platform model and the device information.

These APIs are used to fetch, create, update, or delete the device platform information related to the specified platform model.

Miscellaneous > Db Observer

This API is used to fetch the list of all configured database observer rules.

These APIs are used to fetch, create, update, or delete the parameters related to the specified database observer rule.

Miscellaneous > Track Object

This API is used to fetch the list of all configured VRRP tracking object.

These APIs are used to fetch, create, update, or delete the parameters related to the specified track object ID.

Miscellaneous > Mirror

This API is used to fetch the list of all global profile for mirror configuration.

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

Miscellaneous > Hardware Module Profile

This API is used to fetch the list of all hardware module profiles.

A hardware module profile allows certain device-specific configuration to be applied to a standalone switch, a chassis line-module, or a VSF stack member. It is a mechanism intended to ease the process of configuring these devices with the same set of configurations. Instead of manually configuring each switch, line-module or VSF member, the hardware module profile collects the common configuration settings and allows them to be applied to a specific device or a collection of devices. To apply a hardware module profile to a VSF member or group of VSF members, the hw-profile name here must be referenced from their respective hw-profile endpoints in the switch-stack API.

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

Miscellaneous > Remote Management

This API is used to fetch the list of all remote management configuration.

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

Miscellaneous > Persona Mapping

This API is used to fetch the list of all device type to device function mapping.

These APIs are used to fetch, create, update, or delete the list of device type to device function mapping.

Miscellaneous > IP Routing

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

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

Miscellaneous > Feature Pack

This API is used to fetch the list of all feature pack management server configuration.

These APIs are used to fetch, create, update, or delete the parameters related to a specific feature pack management server profile name.

Miscellaneous > Persona Assignment

This API is used to create a device function list by device function.

Miscellaneous > Static MAC

This API is used to fetch the list of all of static-mac addresses collection configured.

Network Services > DHCP Pool

This API is used to fetch the list of global profile for DHCPv4, or DHCPv6 pool configurations.

These APIs are used to fetch, create, update, or delete the parameters related to the specified DHCPv4, or DHCPv6 pool.

Network Services > Dynamic Arp Inspection

This API is used to fetch the list of all configured dynamic ARP inspection profiles.

Dynamic ARP Inspection is security mechanism placed on a switch to protect against various possible attacks using ARP. This can limit the amount of ARP activity allowed from a host or on a port and can also ensure that all ARP packets are consistent with one or more binding databases which can be created via various means.

It can also enforce integrity checks on the ARP packets to check against using different MAC or IP in the Ethernet or IP header and the ARP header.

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

Network Services > Multicast DNS

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

The Multicast DNS (mDNS) gateway helps users to discover various services such as printers and Apple TV, across VLANs.

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

Network Services > NAE Lite

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

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

Network Services > External Storage

This API is used to fetch the list of all configured global profile for external storage. External storage volumes accessible from the switch.

The feature manages external storage volumes and makes them available to system applications and protocols. The storage is used to store and retrieve data files when capacity use pattern is such that external storage is the best choice. The feature supports network-attached storage as well as local external storage.

These APIs are used to fetch, create, update, or delete the parameters related to the specified global profile for external storage.

Network Services > DHCP Snooping

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

DHCP Snooping is a security feature that helps prevent Denial of Service attacks caused by unauthorized users adding a DHCP server to the network providing invalid configuration data to DHCP clients.

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

Network Services > NAE Script

This API is used to fetch the list of all configured Network Analytics Engine (NAE) scripts.

These APIs are used to fetch, create, update, or delete the parameters related to the specified Network Analytics Engine (NAE) script.

Network Services > IP Binding

This API is used to fetch the list of all source IP binding configuration.

These APIs are used to fetch, create, update, or delete the parameters related to the specified static IP source binding entry.

Network Services > IP Lockdown

This API is used to fetch the list of all configured IP source lockdown profiles.

IP source lockdown feature is used to prevent IP source address spoofing on a per-port basis. When dynamic IP source lockdown is enabled, IP traffic received on a port are forwarded only if IP address, VLAN, MAC address, and Port matches the IP binding entry.

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

Network Services > DHCP Relay

This API is used to fetch the global list of all configured DHCP Relay profiles.

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

Network Services > MGMD

This API is used to fetch the list of all MGMD global configuration.

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

Network Services > IPSLA

This API is used to fetch the list of all Internet Protocol Service Level Agreement (IPSLA) profiles.

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

Network Services > Nae Agent

This API is used to fetch the list of all configured Network Analytics Engine (NAE) agents.

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

Network Services > ND Snooping Interface

This API is used to fetch the list of all configured ND Snooping interface profiles.

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

Network Services > ND Snooping

This API is used to fetch the list of all configured ND Snooping profiles. Enabling the ND-Snooping feature on your switch prevents ND attacks. ND Snooping does not just snoop but also detect attacks by default. ND-Snooping drops invalid ND packets and, together with DIPLDv6, blocks data traffic from invalid hosts.

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

Network Services > DHCP Server

This API is used to fetch the list of all the configured DHCPv4 or DHCPv6 server profiles.

DHCPv4 and DHCPv6 server can automatically allocate IPv4 or IPv6 addresses and deliver configuration settings to client hosts. This can also be configured to provide various network information like IP addresses of DNS server address, boot-file name, vendor-specific options etc.

These APIs are used to fetch, create, update, or delete the parameters related to the specified DHCPv4 or DHCPv6 server profile name.

Network Services > Dynamic ARP Inspection Interface

This API is used to fetch the list of all the configured Dynamic ARP Inspection interface profiles.

These APIs are used to fetch, create, update, or delete the parameters related to the specified Dynamic ARP Inspection interface profile.

Network Services > DHCP Snooping Interface

This API is used to fetch the list of all the configured DHCP Snooping Interface profiles.

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

Network Services > IP Lockdown Interface

This API is used to fetch the list of all the configured IP source lockdown interface profiles.

These APIs are used to fetch, create, update, or delete the parameters related to the specified IP source lockdown interface profile.

Network Services > UDP Broadcast Forwarder

This API is used to fetch the list of all the configured UDP Broadcast Forwarder profiles.

The routers by default do not forward broadcast packets. However, there are scenarios where it is required to forward certain broadcast packets. The UDP (User Datagram Protocol) broadcast forwarder takes the client's UDP broadcast packets and forwards to the configured server(s) in a different subnet. UDP broadcast forwarding is supported only for IPv4 addresses.

Roles & Policy > Role ACL

This API is used to fetch the list of all the configured top-level container for Role ACLs.

Routing & Overlays > Community List

This API is used to fetch the list of all configured Standard IP community.

These APIs are used to fetch, create, update, or delete the parameters related to the specified community list name.

Routing & Overlays > RIP

This API is used to fetch the list of all configured Routing Information Protocol (RIP) profiles.

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

Routing & Overlays > MSDP

This API is used to fetch the list of all configured Multicast Source Discovery Protocol (MSDP) profiles.

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

Routing & Overlays > Prefix List

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

These APIs are used to fetch, create, update, or delete the parameters related to the specified prefix list name address family.

Routing & Overlays > Multicast

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

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

Routing & Overlays > Static Route

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

Static routing is the manual configuration and selection of a network route, managed by the network administrator. It is employed in scenarios where the network routing parameters are not expected to change often.

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

Routing & Overlays > Ospfv2

This API is used to fetch the list of all the OSPFv2 Router instances.

Open Shortest Path First version 2 (OSPFv2) is a routing protocol which is described in RFC2328 entitled OSPF Version 2. It is a Link State-based Interior Gateway Protocol (IGP) routing protocol.

These APIs are used to fetch, create, update, or delete the parameters related to the specified OSPFv2 router instance.

Routing & Overlays > Ospfv3

This API is used to fetch the list of all the OSPFv3 Router instances.

Open Shortest Path First version 3 (OSPFv3) is a routing protocol which is described in RFC5340 entitled OSPF Version 3. It is a Link State-based Interior Gateway Protocol (IGP) routing protocol.

These APIs are used to fetch, create, update, or delete the parameters related to the specified OSPFv3 router instance.

Routing & Overlays > EVPN

This API is used to fetch the list of all the top level Ethernet VPN (EVPN) container.

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

Routing & Overlays > Multicast Static Route

This API is used to fetch the list of all the configured Multicast Static Rout profiles.

Multicast static routes are used to configure a static multicast flow and program it directly into the IP multicast forwarding table instead of learning multicast routes using dynamic multicast protocols.

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

Routing & Overlays > BGP

This API is used to fetch the list of all the top-level configurations for the Border Gateway Protocol (BGP) profiles.

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

Routing & Overlays > PIM

This API is used to fetch the list of all the configured Protocol Independent Multicast (PIM) profiles.

In a network, IP multicast traffic transmitted for multimedia applications is blocked at routed interface boundaries unless a multicast routing protocol is running. Protocol Independent Multicast (PIM) is a family of routing protocols. It forms multicast trees to forward traffic from multicast sources to the clients requesting for traffic.

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

Routing & Overlays > ASPath List

This API is used to fetch the list of all the configured ASPath lists.

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

Routing & Overlays > Routemap

This API is used to fetch the list of all the route map configuration.

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

Routing & Overlays > L3 Route

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

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

Routing & Overlays > VRF

This API is used to fetch the list of all the configured named VRF container.

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

Routing & Overlays > BFD

This API is used to fetch the list of all the configured Bidirectional Forwarding Detection (BFD) profiles.

BFD is a protocol intended to detect faults in the bidirectional path between two forwarding engines, including interfaces, data link(s). It operates independently of media, data protocols, and routing protocols.

Security > Certificate RCP

This API is used to fetch a list of configured certificate TA (Trust Anchor) profiles for certificate Rcp (Revocation Check Point).

This API is used to view, create, edit, or delete the specified TA profile related to a certificate validation method like RCP, OCSP, CRL etc.,

Security > Auth Survivability

This API is used to fetch a list of authentication survivability profiles. When enabled, the access point authenticates previously connected clients using EAP-TLS or MAC authentication even when connectivity to ClearPass Policy Manager is temporarily lost.

This API is used to view, create, edit, or delete parameters related to a specified authentication survivability profile.

Security > Keychain

This API is used to fetch list all available keychains. A keychain is a secure mechanism for storing and managing cryptographic keys and authentication credentials to facilitate secure access and communication between devices.

This API is used to view, create, edit, or delete the specified keychain.

Security > Net Group

This API is used to fetch a list of all network groups. A network group is global container that includes a set of virtual network resources from any region.

This API is used to view, create, edit, or delete the specified network group.

Security > Radius Modifiers

This API is used to fetch the list of all configured RADIUS modifier profiles. The RADIUS modifier profile allows you to configure which attributes are included, excluded, or modified in a RADIUS request before it is sent to the authentication server. This feature is supported only on APs and GWs.

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

Security > AAA Macauth

This API is used to fetch a list of all MAC authentication profiles.

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

Security > Auth Server Global

This API is used to fetch a list of all authentication server global profiles configured.

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

Security > MKA

This API is used to fetch a list of all MACsec Key Agreement (MKA) policies configured. The MKA protocol facilitates the secure management and exchange of cryptographic keys for establishing secure Ethernet communications.

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

Security > Certificate Store

This API is used to fetch the list of customer certificates uploaded to the certificate store.

These APIs are used to fetch, create, update, or delete the parameters related to the specified certificate stored in the certificate store.

Security > AAA Stateful Dot1x

This API is used to fetch the list of all configured stateful 802.1X profiles. When this feature is enabled, it allows the controller to learn the identity and role of a user connected to a third-party AP. It is useful for authenticating users to networks with APs from multiple vendors.

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

Security > AAA Profile

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

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

Security > Certificate

This API is used to fetch the list of all uploaded customer certificates.

These APIs are used to fetch, create, update, or delete the attributes related to the specified certificate.

Security > Copp

This API is used to fetch a list of all configured CoPP (Control Plane Policing) profiles.

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

Security > Passpoint Identity

This API is used to fetch a list of all Passpoint Identity profiles. Passpoint is a Wi-Fi certified solution that enables mobile devices to automatically authenticate on enterprise Wi-Fi networks using their cellular credentials.

These APIs are used to fetch, create, update, or delete the specified Passpoint Identity profiles.

Security > UBT

This API is used to fetch the list of all the configured UBT (User-based tunnel) global profiles.

This feature creates UBT GRE tunnel between the switch and the controller when UBT users are present on the switch. It encapsulates incoming packets from end-hosts in GRE and forwards them to the Mobility Controller. The feature is enabled on a per user tunneled node. Each scope (global, site, site-collection, device, device-collection) can accept only one profile.

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

Security > AP Certificate Usage

This API is used to fetch the list of all the configured access point certificate assignment profiles.

These APIs are used to fetch, create, update, or delete parameters related to the specified access point certificate assignment profile. Use this API to configure certificates that must be used for an application. Certificates must be installed before they can be assigned to an application. This feature is only applicable for AP.

Security > AAA Dot1xauth

This API is used to fetch the list of 802.1X authentication profiles.

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

IEEE 802.1X is an IEEE Standard for port-based Network Access Control (PNAC). This standard provides an authentication mechanism to devices wishing to attach to a LAN or WLAN.

Security > Port Security

This API is used to fetch the list of port security policies available. Use port security to configure each switch port with a unique list of the MAC addresses of devices that are authorized to access the network through that port.

System > IP Source Interface

This API is used to fetch a list of IPv4/IPv6 source interface selection profiles. Use the profile to select an IPv4/IPv6 address or interface name with all outgoing traffic generated by a specific software application on a switch.

These APIs are used to view, create, edit, or delete the specified IPv4/IPv6 source interface selection profile.

System > Local Management

This API is used to fetch a list of local management settings profiles via SSH, Telnet, console or UI. Use these profiles to regulate the authentication, authorization, and accounting (AAA) for device local management.

These APIs are used to view, create, edit, or delete the specified local management settings profile.

System > RMON Alarm

This API is used to fetch a list of RMON (Remote Network Monitoring) alarm profiles. The RMON alarm table periodically takes statistical samples from the SNMP MIB objects in the probe and compares them to previously configured thresholds.

These APIs are used to view, create, edit, or delete the specified RMON alarm profile.

System > System Info

These APIs are used to view, create, edit, or delete system information configurations.

System > Container

This API is used to fetch a list of container configuration profiles.

These APIs are used to view, create, edit, or delete the specified container configuration profile.

System > Countermon

This API is used to fetch a list of counter monitor configuration profiles. The counter monitor is an ASIC counter monitoring mechanism which periodically collects a set of port error counters and updates the latest values into OVSDB.

These APIs are used to view, create, edit, or delete the specified counter monitor configuration profile.

System > IP ICMP TCP

This API is used to fetch a list of IP-ICMP and IP-TCP configuration profiles.

These APIs are used to view, create, edit, or delete the specified IP-ICMP and IP-TCP configuration profile.

System > Speed Test

This API is used to fetch a list of speed test configuration profiles. Use the profiles to run test the speed of communication between the application and a target IP over a specified protocol.

These APIs are used to view, create, edit, or delete the specified speed test configuration profiles.

System > Container Network

This API is used to fetch a list of container network configuration profiles.

These APIs are used to view, create, edit, or delete the specified container network configuration profile.

System > Sysmon

This API is used to fetch a list of system monitoring configuration profiles. The System Resources Monitor daemon collects system parameters for the overall system and all running daemons, then writes it into the OVSDB periodically.

These APIs are used to view, create, edit, or delete the specified system monitoring configuration profile.

System > Job Scheduler

This API is used to fetch a list of all configured job schedules. Use job schedules to execute a job in the near feature. Schedules can be configured to be triggered periodically or at a specific calendar date and time.

Telemetry > Device Finger Printing

This API is used to fetch a list of device finger printing configuration profiles. Device fingerprinting (DFP) collects the set of LLDP/CDP TLVs, DHCP options & HTTP user-agent details from the devices connected to the AOS-CX or AOS-S switches. These details are used to classify the end devices for device-type, vendor, and operating systems using the fingerprinting database.

These APIs are used to view, create, edit, or delete the specified device finger printing configuration profiles.

Telemetry > Flow Management

This API is used to fetch a list of flow tracking profiles. Flow Tracking is a common infrastructure tool to manage the IP Flow table.

This API is used to view, create, edit, or delete a flow tracking profile.

Telemetry > Client Insight

This API is used to fetch a list of client insight configuration profiles.

This API is used to view, create, edit, or delete a client insight configuration profile.

Telemetry > Device Finger Printing Profile

This API is used to fetch a list of device fingerprinting profiles. The device finger printing profile contains a set of protocol data to be collected and associated with the target port(s).

This API is used to view, create, edit, or delete device finger printing profiles.

Telemetry > Traffic Insight

This API is used to fetch a list of traffic insight configuration profiles. Traffic insight collects from various flow exporters like IPFIX and processes data based on user flow monitor requests.

This API is used to view, create, edit, or delete a traffic insight configuration profile.

Telemetry > Device Finger Printing Interface

This API is used to fetch a list of device finger printing interface profiles.

This API is used to view, create, edit, or delete a device finger printing interface profile.

Telemetry > Client IP Tracker Interface

This API is used to fetch a list of client IP tracking configuration profiles for interfaces. The Client IP tracking feature learns and updates the IP address of the access devices and clients connected to the interface. This feature is applicable to AOS-CX and AOS-S Switches.

This API is used to view, create, edit, or delete a client IP tracking configuration profile.

Telemetry > Client IP Tracker

This API is used to fetch a list of client IP tracker configuration profiles. Use the profiles to track the IP addresses of directly connected clients and clients connected to a downstream device such as a wireless access point.

Tunnels > Interface Tunnel

This API is used to fetch a list of tunnel interfaces. A tunnel creates a virtual point-to-point link between two devices encapsulating various protocols within an IP network. Supported modes for tunnels are GRE, IP6in4, IP6in6, IPsec, and VXLAN.

These APIs are used to view, create, edit, or delete a tunnel interface.

Tunnels > Interface Tunnel Group

This API is used to fetch a list of tunnel groups. Use tunnel groups to increase redundancy among tunnels.

VLANs & Networks >VRRP

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

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified VRRP global profile. After configuring the VRRP profile, the profile is referenced from either a VLAN profile or a port profile.

This API is used to fetch the list of all configured MVRP profiles. MVRP provides a mechanism to dynamically share VLAN configuration information across layer 2 switches on a network.

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified MVRP profile.

VLANs & Networks > VRRP Interface

This API is used to fetch, create, or update the list of all VRRP profiles configured.

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified VRRP profile. After configuring the VRRP profile, the profile is referenced from either a VLAN profile or a port profile.

VLANs & Networks > Vlan

This API is used to fetch a list of all layer 2 VLAN profiles configured. Layer 2 VLAN profiles contain authorization, authentication, and access information.

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified layer 2 VLAN profile.

Wireless > Hotspot2 Anqp Nai Realm

This API is used to fetch the list of all ANQP NAI realm configuration profiles. The profiles contain the Network Access Identifier (NAI) information that can be sent as an Access Network Query Protocol (ANQP) information element in a generic advertisement service query response.

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified ANQP NAI realm configuration profile.

Wireless > Hotspot2 Anqp Domain Name

This API is used to fetch the list of all ANQP NAI domain configuration profiles. The profiles contain the domain information that can be sent as an Access Network Query Protocol (ANQP) information element in a generic advertisement service query response.

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified ANQP NAI domain profile.

Wireless > Alg

This API is used to fetch a list of all Aruba AP ALG profiles configured. These profiles contain the Aruba AP ALG (SCCP, SIP, UA, Vocera) configuration.

These APIs are used to fetch, create, configure, update, or delete the parameters for the specified Aruba AP ALG profile.

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

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. It includes some important configurations like radio bands, channels, rates and transmit power etc.

This feature is only applicable for AP.

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

This API is used to fetch the list of all the configured ANQP available IP address types profiles.

This defines the available IP address types to be sent in an Access network Query Protocol (ANQP) information element in a Generic Advertisement Service (GAS) query response.

These APIs are used to fetch, create, update, or delete the parameters related to a specific ANQP available IP address types profile.

This API is used to fetch the list of all the configured Hotspot 2.0 Query Protocol (H2QP) profile that advertises hotspot protocol and port capabilities.

The values in this profile can be sent in an Access network Query Protocol (ANQP) IE to inform hotspot clients about the IP protocols and port numbers available for communication.

These APIs are used to fetch, create, update, or delete the parameters related to a specific hotspot protocol and port capabilities profile.

This API is used to fetch the list of all the configured ANQP network authentication profiles.

The Roaming Consortium OI information is sent in an Access network Query Protocol (ANQP) information element in a Generic Advertisement Service (GAS) query response. Organization Identifiers (OIs) are assigned to service providers when they register with the IEEE Registration Authority.

These APIs are used to fetch, create, update, or delete the parameters related to a specific ANQP network authentication profile.

This API is used to fetch the list of all the configured ANQP Roaming Consortium OI information profiles.

The Access network Query Protocol (ANQP) network authentication profile specifies the authentication type for the hotspot network. When the Additional Steps Required for Access (ASRA) option is enabled in the hotspot profile associated with a WLAN SSID, the configured authentication settings are included in the GAS response to the client.

These APIs are used to fetch, create, update, or delete the parameters related to a specific ANQP Roaming Consortium OI information profile.

This API is used to fetch the list of all the configured Hotspot 2.0 Query Protocol (H2QP) profiles that defines the Operating Class to be sent in the H2QP IE.

The values configured in this H2QP Operating Class profile define the channels on which the hotspot is capable of operating.

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

This API is used to fetch the list of all the configured Hotspot 2.0 Query Protocol (H2QP) profiles that specifies the hotspot WAN status and link metrics.

The values configured in this profile can be sent in an ANQP IE to inform hotspot clients about access network characteristics such as link status and WAN capacity and speed.

These APIs are used to fetch, create, update, or delete the parameters related to a specific H2QP metrics and WAN status profile.

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

Hotspot 2.0 is a WFA specification based upon the 802.11u protocol that provides wireless clients with a streamlined mechanism to discover and authenticate to suitable networks. This allows mobile users the ability to roam between partner networks without additional authentication.

Monitoring > Gateways

The following API paths are updated.

New API path

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/lan-tunnels/{tunnel-id}

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

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/cpu-utilization-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/memory-utilization-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/tunnels/lan-tunnels/{tunnel-id}/throughput-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/tunnels/lan-tunnels/{tunnel-id}/status-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/ports/{port-number}/throughput-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels/{tunnel-id}/packets-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels/{tunnel-id}

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

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/uplinks/{link-tag}

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/uplinks/{link-tag}/throughput-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/uplinks/{link-tag}/wan-compression-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/uplinks/{link-tag}/probes

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/uplinks/{link-tag}/probes/{probe}/performance-trends

[GET] /network-monitoring/v1alpha1/gateways/{serial-number}/wan-tunnels/{tunnel-id}/aggregated-usage

[GET] /network-monitoring/v1alpha1/clusters/{cluster-name}/leader

[GET] /network-monitoring/v1alpha1/clusters/{cluster-name}/vlan-mismatch

[GET] /network-monitoring/v1alpha1/clusters/{cluster-name}

[GET] /network-monitoring/v1alpha1/clusters/{cluster-name}/tunnels

Monitoring > Site Health

[GET] /network-monitoring/v1alpha1/sites-client-health

All the APIs listed under Monitoring > Device Location are removed.

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

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

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

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

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

Monitoring > GDPR

The APIs listed under Monitoring > GDPR are removed.