CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

[2602.1.10] - 2026-04-08

• Added minis-application webhook sample
• Updated listOrgSecIntelProfiles to support pagination via limit and page query parameters

[2602.1.9] - 2026-03-19

• Updated schema definitions for gateway and gateway_template:
  • Added gateway_mgmt field with sub-properties: admin_sshkeys, app_probing, app_usage, auto_signature_update, config_revert_timer, disable_console, disable_oob, disable_usb, fips_enabled, probe_hosts, probe_hostsv6, protect_re, root_password, security_log_source_address, security_log_source_interface
• Updated schema definitions for site_setting:
  • Consolidated gateway_mgmt to use shared #/components/schemas/gateway_mgmt schema
• Removed deprecated schemas (now consolidated into gateway_mgmt):
  • site_setting_gateway_mgmt, site_setting_gateway_mgmt_admin_sshkeys, site_setting_gateway_mgmt_auto_signature_update, site_setting_gateway_mgmt_probe_hosts, site_setting_gateway_mgmt_probe_hostsv6
• Added format: password to sensitive credential fields across multiple schemas for improved security handling (passwords, secrets, API keys, auth tokens)

[2602.1.8] - 2026-03-18

• Updated /api/v1/sites/{site_id}/insights/device/{device_mac}/{metric}
  • Added optional port_id query parameter for interface-specific metrics
• Updated /api/v1/sites/{site_id}/insights/gateway/{device_id}/stats
  • Added optional port_id query parameter for interface-specific metrics
• Updated /api/v1/sites/{site_id}/insights/mxedge/{device_mac}/{metric}
  • Added optional port_id query parameter for interface-specific metrics
• Updated /api/v1/sites/{site_id}/insights/switch/{device_mac}/{metric}
  • Added optional port_id query parameter for interface-specific metrics

[2602.1.7] - 2026-03-18

• Added /api/v1/sites/{site_id}/insights/ap/{device_id}/stats
  • New endpoint for AP Insight Metrics with required metrics query parameter
• Updated /api/v1/orgs/{org_id}/stats
  • Removed start, end, duration, limit, page query parameters not applicable to org-level stats endpoint
• Updated /api/v1/orgs/{org_id}/stats/sites
  • Removed start, end, duration query parameters not applicable to site-level stats endpoint
• Updated /api/v1/sites/{site_id}/insights
  • Changed path from /api/v1/sites/{site_id}/insights/{metric} to use metrics query parameter instead of path parameter
• Updated /api/v1/sites/{site_id}/insights/client/{client_mac}
  • Changed path from /api/v1/sites/{site_id}/insights/client/{client_mac}/{metric} to use metrics query parameter instead of path parameter
• Updated /api/v1/sites/{site_id}/insights/gateway/{device_id}/stats
  • Changed path from /api/v1/sites/{site_id}/insights/gateway/{device_id}/stats/{metric} to use metrics query parameter instead of path parameter
• Updated schema definitions for gateway and gateway_template:
  • .oob_ip_configs.vlan_id, .oob_ip_configs.node1.vlan_id: Changed type from string to oneOf with string and integer to support both string and numeric VLAN IDs

[2602.1.6] - 2026-03-05

• Improve query parameter descriptions when partial search is supported with wildcard (*) for better clarity on search behavior
• Updated schema definitions
  • Added uplink field (boolean) to stats_switch_port to indicate if interface is an uplink port

[2602.1.5] - 2026-03-03

• Updated /api/v1/sites/{site_id}/insights/fingerprints/count and /api/v1/sites/{site_id}/insights/fingerprints/search
  • Updated operationIds from countOrgClientFingerprints/searchOrgClientFingerprints to countSiteClientFingerprints/searchSiteClientFingerprints
  • Updated tag from Orgs NAC Fingerprints to Sites NAC Fingerprints
• Updated /api/v1/orgs/{org_id}/inventory
  • Removed vc_mac and master_mac query parameters
  • Added model and name query parameters
  • Updated status parameter to use enum reference (connected, disconnected)
• Updated /api/v1/sites/{site_id}/devices/{device_id}/clear_dot1x_mac_limit
  • Changed port_id to ports (array) to support clearing multiple ports
• Updated /api/v1/sites/{site_id}/devices/{device_id}/clear_policy_hit_count
  • Added policy_name request body parameter (required)
• Updated /api/v1/sites/{site_id}/devices/{device_id}/show_arp
  • Changed tag from Utilities Common to Utilities LAN
• Updated schema definitions
  • clear_dot1x_session: changed port_id to ports (array)
  • utils_clear_bpdu: changed port to ports (array)
  • utils_release_dhcp_leases: changed mac to macs
  • utils_show_arp: added node field for HA cluster support on Gateways

[2602.1.4] - 2026-02-26

• Updated /api/v1/orgs/{org_id}/inventory
  • Updated type parameter to support multiple comma-separated values from: ap, gateway, router, switch, all (default: ap)
• Updated /api/v1/orgs/{org_id}/jsi/inventory/search
  • Replaced eol_duration and eos_duration with date-based filters: eol_after, eol_before, eos_after, eos_before
  • Added version_eos_after and version_eos_before parameters for software version end-of-support filtering
  • Added sirt_id and pbn_id parameters for security advisory filtering
  • Updated text parameter description to clarify wildcard support
• Updated /api/v1/sites/{site_id}/devices
  • Updated type parameter to support multiple comma-separated values from: ap, gateway, router, switch, all (default: ap)
• Added /api/v1/sites/{site_id}/mapstacks
• Updated /api/v1/sites/{site_id}/setting
  • Added gateway_tunnel_updown_threshold field (integer) to enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery
  • Added allow_mist field (boolean) to control whether Mist can access this site
  • Added ap_synthetic_test.additional_vlan_ids field (array of integers) for additional VLAN IDs in synthetic tests
• Updated webhook schemas
  • Added new webhook topic minis-reachability for AP synthetic test reachability events
  • Updated webhook_minis_reachability_event timestamp field to use shared #/components/schemas/timestamp reference for consistency
  • Added webhook sample endpoint for minis-reachability topic at /webhooks/minis_reachability
• Updated schema definitions
  • Added wlan.disable_message_authenticator_check field (boolean) to disable Message-Authenticator Check for RADIUS message integrity verification (default: false for better security)
  • Updated extra_route and extra_route6 schemas to reference shared next_hop_via schema for better reusability and support for ECMP (Equal-Cost Multi-Path) load balancing
  • Replaced mapstack_id and mapstack_floor with group_name and group_idx in map schema for maps grouping (group_idx typically used for floor)

[2602.1.3] - 2026-02-24

• Updated websocket API examples for clarity and completeness
• Improved alarm_group description
• Added missing site_id query parameter to searchOrgWanClients
• Added missing query parameter message and sort to listSelfAuditLogs

[2602.1.2] - 2026-02-24

• Updated /api/v1/sites/{site_id}
  • Added routertemplate_id field
• Updated /api/v1/orgs/{org_id}/sites
  • Added routertemplate_id field

[2602.1.1] - 2026-02-19

• Updated /api/v1/orgs/{org_id}/sites/search
  • Updated name parameter description to clarify it is case insensitive and supports partial search with wildcard (*)
• Updated /api/v1/orgs/{org_id}/stats/ports/search
  • Removed unsupported site_id query parameter
• Updated schema definitions
  • Added deprecated: true attribute to managed and disable_auto_config fields
  • Fixed inline complex definitions

[2602.1.0] - 2026-02-10

• Added /api/v1/orgs/{org_id}/aos/register_cmd
• Added /api/v1/orgs/{org_id}/jsi/pbn/count
• Added /api/v1/orgs/{org_id}/jsi/pbn/search
• Added /api/v1/orgs/{org_id}/jsi/sirt/count
• Added /api/v1/orgs/{org_id}/jsi/sirt/search
• Added /api/v1/orgs/{org_id}/mxedges/{mxedge_id}/vm_params
• Added /api/v1/orgs/{org_id}/usermacs/count
• Added /api/v1/sites/{site_id}/maps/auto_geofences
  • Run auto geofence service for all maps in a site
• Added /api/v1/sites/{site_id}/maps/{map_id}/auto_geofences
  • Run auto geofence service for a single map
• Updated /api/v1/orgs/{org_id}/nac_clients/search
• Updated /api/v1/orgs/{org_id}/setting
  • Added allow_mist field
• Updated /api/v1/orgs/{org_id}/stats
  • Added allow_mist field to response
• Updated /api/v1/sites/{site_id}/analyze_spectrum
  • Added channels parameter to request body
  • Added minimum: 60 constraint to duration parameter
• Updated /api/v1/sites/{site_id}/setting/derived
  • Added allow_mist field to response
• Updated /api/v1/sites/{site_id}/stats/devices
  • Added ip, mac, product_id, vendor_id fields to esl_stat for Hanshow and SoluM dongles

[2511.1.6] - 2025-12-11

• Updated /api/v1/orgs/{org_id}/networktemplates Updated /api/v1/orgs/{org_id}/networktemplates/{networktemplate_id} Updated /api/v1/sites/{site_id}/devices Updated /api/v1/sites/{site_id}/devices/import Updated /api/v1/sites/{site_id}/devices/{device_id} Updated /api/v1/sites/{site_id}/networktemplates/derived Updated /api/v1/sites/{site_id}/setting Updated /api/v1/sites/{site_id}/setting/derived
  • Added bgp_config for switches
• Updated /api/v1/orgs/{org_id}/deviceprofiles Updated /api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id} Updated /api/v1/orgs/{org_id}/evpn_topologies Updated /api/v1/orgs/{org_id}/evpn_topologies/{evpn_topology_id} Updated /api/v1/orgs/{org_id}/networktemplates Updated /api/v1/orgs/{org_id}/networktemplates/{networktemplate_id} Updated /api/v1/sites/{site_id}/deviceprofiles/derived Updated /api/v1/sites/{site_id}/devices Updated /api/v1/sites/{site_id}/devices/import Updated /api/v1/sites/{site_id}/devices/{device_id} Updated /api/v1/sites/{site_id}/evpn_topologies Updated /api/v1/sites/{site_id}/evpn_topologies/{evpn_topology_id} Updated /api/v1/sites/{site_id}/networktemplates/derived Updated /api/v1/sites/{site_id}/setting Updated /api/v1/sites/{site_id}/setting/derived
  • Added networks to port_config
• Updated /api/v1/orgs/{org_id}/deviceprofiles Updated /api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id} Updated /api/v1/orgs/{org_id}/gatewaytemplates Updated /api/v1/orgs/{org_id}/gatewaytemplates/{gatewaytemplate_id} Updated /api/v1/sites/{site_id}/deviceprofiles/derived Updated /api/v1/sites/{site_id}/gatewaytemplates/derived Updated /api/v1/sites/{site_id}/setting Updated /api/v1/sites/{site_id}/setting/derived
  • Updated gateway_matching to use gateway_port_config component for port_config property

[2511.1.0] - 2025-11-17

• Marked /api/v1/orgs/{org_id}/128routers/register_cmd as deprecated, replaced by /api/v1/orgs/{org_id}/ssr/register_cmd
• Added /api/v1/orgs/{org_id}/ssr/export_idtokens
• Added /api/v1/orgs/{org_id}/stats/ospf_peers/count
• Added /api/v1/orgs/{org_id}/stats/ospf_peers/search
• Added /api/v1/sites/{site_id}/devices/gbp_tag
• Added /api/v1/sites/{site_id}/stats/ospf_peers/count
• Added /api/v1/sites/{site_id}/stats/ospf_peers/search
• Updated /api/v1/orgs/{org_id}/devices/last_config/search
  • Added cert_expiry_duration query parameter
• Updated /api/v1/orgs/{org_id}/deviceprofiles
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added skyatp and syslog to gateway service_policies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/orgs/{org_id}/deviceprofiles/{deviceprofile_id}
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added skyatp and syslog to gateway service_policies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/orgs/{org_id}/evpn_topologies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/orgs/{org_id}/evpn_topologies/{evpn_topology_id}
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/orgs/{org_id}/gatewaytemplates
  • Added skyatp and syslog to gateway service_policies
• Updated /api/v1/orgs/{org_id}/gatewaytemplates/{gatewaytemplate_id}
  • Added skyatp and syslog to gateway service_policies
• Updated /api/v1/orgs/{org_id}/jsi/inventory/search
  • Added claimed query parameter
  • Added has_support query parameter
• Updated /api/v1/orgs/{org_id}/mxclusters
  • Added disabled to proxy
• Updated /api/v1/orgs/{org_id}/mxclusters/{mxcluster_id}
  • Added disabled to proxy
• Updated /api/v1/orgs/{org_id}/mxedges
  • Added disabled to proxy
• Updated /api/v1/orgs/{org_id}/mxedges/{mxedge_id}
  • Added disabled to proxy
• Updated /api/v1/orgs/{org_id}/mxedges/search
  • Added inactive_vlan_strs
• Updated /api/v1/orgs/{org_id}/nacportals
  • Added additional_cacerts
• Updated /api/v1/orgs/{org_id}/nacportals/{nacportal_id}
  • Added additional_cacerts
• Updated /api/v1/orgs/{org_id}/networktemplates
  • Added bypass_auth_when_server_down_for_voip and poe_priority for ports
• Updated /api/v1/orgs/{org_id}/networktemplates/{networktemplate_id}
  • Added bypass_auth_when_server_down_for_voip and poe_priority for ports
• Updated /api/v1/orgs/{org_id}/setting
  • Added disabled to ssr proxy
• Updated /api/v1/orgs/{org_id}/sites
  • Removed apporttemplate_id from response
• Updated /api/v1/orgs/{org_id}/stats/devices
  • Added poe_priority for switch stats
• Updated /api/v1/orgs/{org_id}/stats/mxedges
  • Added inactive_vlan_strs
• Updated /api/v1/orgs/{org_id}/stats/mxedges/{mxedge_id}
  • Added inactive_vlan_strs
• Updated /api/v1/orgs/{org_id}/stats/ports/search
  • Added poe_priority query parameter
• Updated /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps
  • Added group_idx and group_name to response
• Updated /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}
  • Added group_idx and group_name to request and response
• Updated /api/v1/sites/{site_id}
  • Removed apporttemplate_id from response
• Updated /api/v1/sites/{site_id}/devices
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added skyatp and syslog to gateway service_policies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/sites/{site_id}/devices/clear_pending_version
  • Added request body schema and example
• Updated /api/v1/sites/{site_id}/devices/import
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added skyatp and syslog to gateway service_policies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/sites/{site_id}/devices/last_config/search
  • Added cert_expiry_duration query parameter
• Updated /api/v1/sites/{site_id}/devices/restore_backup_version
  • Added request body schema and example
  • Updated supported devices listed in description
• Updated /api/v1/sites/{site_id}/devices/{device_id}
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added skyatp and syslog to gateway service_policies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/sites/{site_id}/devices/{device_id}/ping
  • Added vrf
• Updated /api/v1/sites/{site_id}/devices/{device_id}/restore_backup_version
  • Updated supported devices listed in description
• Updated /api/v1/sites/{site_id}/deviceprofiles/derived
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added skyatp and syslog to gateway service_policies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/sites/{site_id}/evpn_topologies
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/sites/{site_id}/evpn_topologies/{evpn_topology_id}
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switch ports
• Updated /api/v1/sites/{site_id}/maps
  • Added group_idx and group_name to request and response
• Updated /api/v1/sites/{site_id}/maps/{map_id}
  • Added group_idx and group_name to request and response
• Updated /api/v1/sites/{site_id}/mxedges
  • Added disabled to proxy
• Updated /api/v1/sites/{site_id}/mxedges/{mxedge_id}
  • Added disabled to proxy
• Updated /api/v1/sites/{site_id}/networktemplates/derived
  • Added bypass_auth_when_server_down_for_voip and poe_priority for ports
• Updated /api/v1/sites/{site_id}/setting
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added disabled to proxy
  • Added skyatp and syslog to gateway service_policies
  • Added disabled to ssr proxy
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switches and ports
• Updated /api/v1/sites/{site_id}/setting/derived
  • Renamed ant_mode to antenna_select, added rrm_managed, antenna_beam_pattern
  • Added disabled to proxy
  • Added skyatp and syslog to gateway service_policies
  • Added disabled to ssr proxy
  • Added bypass_auth_when_server_down_for_voip and poe_priority for switches and ports
• Updated /api/v1/sites/{site_id}/stats/devices
  • Renamed ant_mode to antenna_select
  • Added poe_priority for switch stats
• Updated /api/v1/sites/{site_id}/stats/devices/{device_id}
  • Renamed ant_mode to antenna_select
  • Added poe_priority for switch stats
• Updated /api/v1/sites/{site_id}/stats/mxedges
  • Added inactive_vlan_strs
• Updated /api/v1/sites/{site_id}/stats/mxedges/{mxedge_id}
  • Added inactive_vlan_strs
• Updated /api/v1/sites/{site_id}/stats/ports/search
  • Added poe_priority