API Change Log in June 2026

This topic lists the APIs updated in this release.

New MRT APIs

Table 1: New MRT APIs

Method

Path

Description

Notifications > Notification Rules

GET

/network-notifications/v1/notification-rules

This API is used to fetch the list of notification rules. The notification rules list includes data source and destination channel details.

POST

/network-notifications/v1/notification-rules

This APIs are used to create a notification rule.

GET, PATCH, or DELETE

/network-notifications/v1/notification-rules/{id}

These APIs are used to fetch, update, or delete the specified notification rule by ID.

Reporting > Reporting
POST /network-reporting/v1/reports This API is used to generate reports based on report-specific filters, report periods, and scheduling options. Reports can be scheduled for one-time or recurring execution and sent by email in multiple formats.
GET, PUT, or DELETE /network-reporting/v1/reports/{report-id} This API is used to fetch, update, or delete a specific user report by report ID. Report ID can be obtained from list reports API call (GET network-reporting/v1/reports) or in create Report API call (POST /network-reporting/v1/reports) response.
DELETE /network-reporting/v1/reports/{report-id}/report-runs/{report-run-id} This API deletes a particular report runs with report run ID. Report ID can be obtained from list reports API call (GET network-reporting/v1/reports) and report run ID can be obtained from list report Runs API call (GET /network-reporting/v1/reports/{report-id}/report-runs).
POST /network-reporting/v1/reports/{report-id}/report-runs/{report-run-id}/download-link This API is used to retrieve a downloadable link for a previously generated report run. Users can specify the export file format (CSV or PDF) by providing the appropriate exportType parameter in the request body. The response will contain the file's download URL, MIME type (application/zip for CSV file format and application/pdf for PDF file format), and the suggested file name for the report.
GET /network-reporting/v1/reports-meta This API is used to fetch reports metadata such as list of KPIS filters applicable for report types. This information is required when creating reports.

Services > Radio

GET

/network-services/v1/airmatch-radio

This API is used to fetch the following information:

  • Radio reporting information for all radios in a tenant, or

  • For radios associated with a specific AP serial number, when the AP Serial query parameter is provided.

GET

/network-services/v1/airmatch-radio/{radio-mac}

This API is used to fetch radio reporting information for a specific tenant based on the provided radio MAC address.
GET /network-services/v1/airmatch-radio-partition/{radio-mac}

This API is used to fetch the RF domain and friend partition id for a specific radio MAC address for a given tenant.

Services > AP

GET

/network-services/v1/airmatch-ap

This API is used to fetch access point (AP) information for all APs for a given tenant.

GET

network-services/v1/airmatch-ap/{serial-number}

This API is used to fetch access point (AP) information for a specified tenant based on the provided AP serial number.

GET

/network-services/v1/airmatch-ap-neighbor-list/{serial-number}

This API is used to fetch a list of neighboring Access Points (APs), identified by their serial numbers, for a specified AP within a given tenant.

Services > Priority RF Events

GET

/network-services/v1/airmatch-priority-rf-events

This API is used to fetch all Priority Radio Frequency (RF) channel change events triggered by Radar detection or noise for a specified tenant.

GET

/network-services/v1/airmatch-priority-rf-events/{radio-mac}

This API is used to fetch Priority RF events that triggered channel changes due to Radar detection or noise for a specified radio MAC address within the tenant.

Services > RF Events

GET

/network-services/v1/airmatch-rf-events

This API is used to fetch all non-Priority Radio Frequency (RF) channel change events triggered by Radar detection or noise for a specified tenant.
GET /network-services/v1/airmatch-rf-events/{radio-mac}

This API is used to fetch a list of non-Priority Radio Frequency (RF) events that triggered channel changes due to Radar detection or noise for a specified radio MAC address within a given tenant.

Services > History
GET /network-services/v1/airmatch-history/{radio-mac} This API is used to fetch the radio history events for a specific Radio MAC address for a given tenant.

Services > Service Configuration
GET /network-services/v1/airmatch-service-config This API is used to fetch device running configuration for a given tenant.

Services > Global Configuration
GET /network-services/v1/airmatch-global-config-id This API is used to fetch the global configuration ID for the tenant.

Services > Radio Feasibility
GET /network-services/v1/airmatch-radio-feasibility This API is used to fetch the current radio feasibility for all radios for a given tenant.
GET /network-services/v1/airmatch-radio-feasibility/{radio-mac} This API is used to fetch the current radio feasibility for a specific radio MAC address for a given tenant.

Services > Board Limit
GET /network-services/v1/airmatch-board-limit/{serial-number}/{radio-mac} This API is used to fetch the board limits of the radio for a given tenant.

Services > Device Configuration
GET /network-services/v1/airmatch-device-config/{serial-number} This API is used to fetch the device configuration for a specific AP Serial number for a given tenant.

Services > Neighbor Pathloss
GET /network-services/v1/airmatch-non-friend/{radio-mac} This API is used to fetch a list of non-friend (non-neighbor) radios for that radio MAC for a given tenant.
GET /network-services/v1/airmatch-pathloss/{radio-mac} This API is used to fetch all neighbors and pathloss information heard by a radio for a given tenant
Service > Radio Frequency Domain
GET /network-services/v1/airmatch-partition This API is used to fetch RF partition information for a specified tenant, including the list of radios in each partition, along with the associated RF domain and partition details.
POST /network-services/v1/airmatch-partition This API is used to send an RF Partition Request to Airmatch to create new RF partitioning based on current pathloss information
Service > Solution
GET /network-services/v1/airmatch-solution This API is used to fetch the list of solver optimizations (solutions) generated by Airmatch for a specified tenant. It supports multiple query parameters for filtering and pagination. If no query parameters are provided, the API returns all available solutions for the tenant, subject to the default pagination limit.
POST /network-services/v1/airmatch-runnow This API is used to send an optimization request to Airmatch to compute and deploy a solution.
GET /network-services/v1/airmatch-solution/{radio-mac} This API is used to fetch solution or radio plan of a specific radio for a given tenant.
GET /network-services/v1/airmatch-ap-coverage-plan This API is used to fetch all AP coverage plan for a given tenant.
GET /network-services/v1/airmatch-ap-coverage-plan/{serial-number} This API is used to fetch the AP coverage plan for a given AP serial number for a tenant.
GET /network-services/v1/airmatch-state This API is used to fetch the current migration state for a given tenant.
Service > Audit Trail Information
GET /network-services/v1/audits This API is used to fetch all the audit logs based on the tenants.
GET /network-services/v1/audits/{id} This API is used to fetch the audit log entry for a given audit ID.

Monitoring > Gateways

GET

/network-monitoring/v1/gateways/{serial-number}/modem-stat

This API is used to fetch the modem statistics data for the specified gateway.

Monitoring > Application Visibility

GET

/network-monitoring/v1/application-categories

This API is used to fetch the top N application categories ranked by total usage (TX + RX bytes) for the specified scope. The maximum supported time range is 7 days. If the interval between start-at and end-at exceeds 7 days, the start-at value is automatically adjusted to 7 days before end-at. This behavior is intentional, and no error is returned.

GET

/network-monitoring/v1/security-risks

The API is used to fetch a breakdown of application security risks (High, Medium, and Low) for the specified scope. The maximum supported time range is 7 days. If the interval between start-at and end-at exceeds 7 days, the start-at value is automatically adjusted to 7 days before end-at. This behavior is intentional, and no error is returned.

GET

/network-monitoring/v1/website-categories

This API is used to fetch the top N website categories ranked by total usage (TX + RX bytes) for the specified scope. The maximum supported time range is 7 days. If the interval between start-at and end-at exceeds 7 days, the start-at value is automatically adjusted to 7 days before end-at. This behavior is intentional, and no error is returned.

New Configuration APIs

Table 2: New Configuration APIs

Method

Path

Description

Security > First Hop Security

GET

/network-config/v1alpha1/first-hop-security

This API is used to fetch the list of all configured First Hop Security profiles.

GET, POST, PATCH, or DELETE

/network-config/v1alpha1/first-hop-security/{name}

This API is used to fetch, create, update, or delete a specific First Hop Security profile.

Security > DOS

GET

/network-config/v1alpha1/dos

This API is used to fetch the list of all configured DoS (Denial of Service) profiles.

GET, POST, PATCH, or DELETE

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

This API is used to fetch, create, update, or delete a specific DoS profile.

System > Hardware Module Device

GET

/network-config/v1alpha1/hardware-module

This API is used to fetch the list of hardware module profiles. A hardware module profile defines device-specific hardware configuration for a standalone switch, a chassis line module, or a VSF stack member. Each profile targets a specific device type and encapsulates the hardware settings applicable to that type, enabling consistent configuration across devices of the same kind.

GET, POST, PATCH, or DELETE

/network-config/v1alpha1/hardware-module/{name}

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

Modified APIs

MRT APIs

Table 3: Modified MRT APIs

Method

Description

Monitoring > Site Health

GET /network-monitoring/v1/site-health/{site-id}

This API only supports the site-id parameter. To get the site-id, use the GET /network-monitoring/v1/sites-health using the siteName filter.

Monitoring > Access Point

GET /network-monitoring/v1/aps/{serial-number}

The API response now includes the is_uplink parameter to identify whether a port is currently configured and operating as an uplink.

GET /network-monitoring/v1/wlans/{wlan-name}

The API response is enhanced to include the client_count for the specified WLAN.

Notifications > Alerts

GET /network-notifications/v1/alerts/clear

This API is updated to make the reason field a mandatory parameter in the request body.

Troubleshooting > Events

GET /network-troubleshooting/v1/events

The sort field in this API is updated to use timeAt instead of timestamp.

Troubleshooting > AOS-S Switches

Troubleshooting > CX Switches

For switch stacks, the APIs listed under AOS-S Switches and CX switches support the use of either the conductor serial number or the stack ID in the serial-number path parameter.

Configuration APIs

Table 4: Modified Configuration APIs

Method

Description

Named Object > Alias

POST /network-config/v1alpha1/aliases/{name}

This API is updated to allow ALIAS_IPV6_SYSTEM_VLAN to be selected as the value for the type parameter.

System > Gw System

The deny-inter-user-bridging-allowed-addresses parameter is removed from the firewall container. This parameter can now be configured using the First Hop Security API.

POST /network-config/v1alpha1/gw-system/{name}

This API is updated to allow ipv6-device-vlan-alias to be configured.

System > Switch System

The Switch System APIs are enhanced to configure the client insight parameters. The following parameters are added to the Switch System APIs:

  • enable— Enable or disable the Client Insight feature, which captures L2, L3, and L4 onboarding details of clients connected to the switch. The details are published to HPE Aruba Networking Central to provide enhanced visibility into client activities. Available on AOS-CXand AOS-S switches.

  • onboarding-event-log— Enable or disable client onboarding status event logging. When enabled, the switch generates event logs for each client's onboarding outcome (success or failure with reason codes). Requires Client Insight to be enabled. Available on AOS-CX switches only.

Security > Firewall

The APIs listed under the Firewall is updated with the following changes:

IPv4 Container

  • The attack-rate parameter is removed from the IPv4 container. This parameter can now be configured using the DoS API.

  • The local-valid-users, prevent-dhcp-exhaustion, prohibit-arp-spoofing, prohibit-ip-spoof-all, and prohibit-ip-spoofing parameters are removed from the IPv4 container. These parameters can now be configured using the First Hop Security API.

  • The enable-stateful-icmp, enforce-tcp-handshake, and enforce-tcp-sequence parameters are removed from the IPv4 container. These parameters can now be configured using the GW System API.

IPv6 Container

  • The attack-rate parameter is removed from the IPv6 container. This can now be configured using the DoS API.

  • The enable-stateful-icmp, enforce-tcp-handshake, and enforce-tcp-sequence parameters are removed from the IPv6 container. These parameters can now be configured using the GW System API.

Configuration Health > Configuration Health

GET /network-config/v1alpha1/config-health/active-issue

This API is enhanced to include additionalInfo parameter in the response body. Additional information about the distribution failure is displayed.

GET /network-config/v1alpha1/config-health/devices

This API is enhanced to include serialNumber parameter in the response body.

Interfaces > Interface Loopback

POST /network-config/v1alpha1/loopback-interfaces/{id}

The following parameters are listed as deprecated:

  • ipv4

  • ipv4-prefix

  • ipv6-address

  • ipv6-addresses

  • link-local

  • secondary-ip

The above parameters can be configured using the ipv4-config and ipv6-config containers.

Deprecated APIs

Table 5: Deprecated APIs

Deprecated API

Alternate APIs

All alpha MRT APIs (v1alpha1, and v1alpha2) are marked as deprecated. You must use the corresponding v1 APIs.

Configuration > Telemetry > Client Insight

The APIs listed under Client Insight are deprecated. Use the Switch System API to configure Client Insight parameters.

Configuration > System > Hardware Module Profile

The list of APIs listed under Hardware Module Profile is getting deprecated.

GET /network-config/v1alpha1/hardware-module

GET /network-config/v1alpha1/hardware-modules

GET, POST, PATCH, or DELETE /network-config/v1alpha1/hardware-module/{name}

GET, POST, PATCH, or DELETE /network-config/v1alpha1/hardware-modules/{name}