Monitoring and Troubleshooting

The following sections describe the API changes from version 26.1 to 26.2.

Table of Contents

Breaking changes (4)

• [Monitoring - Alarms Details]
  • GET /alarms/purgefrequency
• [Monitoring - Health]
  • GET /health/devices
• [Monitoring - Search]
  • GET /v1/search
• [Monitoring - Stats Download]
  • GET /statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}

New (27)

• [Monitoring - Alarms Details]
  • POST /alarms/purgefrequency
• [Monitoring - Alarms Notification]
  • POST /notifications/rule/{type}
  • PUT /notifications/rule/{type}
• [Monitoring - CDP]
  • GET /device/cdp/neighbors
  • POST /device/cdp/neighbors
• [Monitoring - Device Configuration Security Advisories]
  • GET /advisories/insecure-config/summary
• [Monitoring - LLDP]
  • GET /device/lldp/neighbors
  • POST /device/lldp/neighbors
• [Monitoring - Stats Download]
  • GET /statistics/download/{processType}/file/{token}/{fileName}
• [Real-Time Monitoring - BFD]
  • GET /device/bfd/state/remoteSiteList
• [Real-Time Monitoring - Cellular]
  • GET /device/cellular/dyingGasp
  • GET /device/cellular/gps
• [Real-Time Monitoring - Interface]
  • GET /device/interface/config
• [Real-Time Monitoring - Lpshield]
  • GET /device/system/lpshield
• [Real-Time Monitoring - Next Generation Firewall Update Status]
  • GET /device/ngfw/engine-status
  • GET /device/ngfw/lsp-update-status
  • GET /device/ngfw/vdb-update-status
  • GET /device/ngfw/version-status
• [Real-Time Monitoring - Power Management]
  • GET /device/powermgmt/status
• [Real-Time Monitoring - Power Management Daily History]
  • GET /device/powermgmt/history/daily
• [Real-Time Monitoring - Power Management Hourly History]
  • GET /device/powermgmt/history/hourly
• [Real-Time Monitoring - QFP]
  • GET /device/qfp/classificationmem
  • GET /device/qfp/classificationtcam
• [Real-Time Monitoring - Switchport]
  • GET /device/switchport
• [Real-Time Monitoring - device/vlan]
  • GET /device/vlan
• [Troubleshooting Tools - Device Connectivity]
  • POST /device/tools/admintech/delayed/cancel
  • POST /device/tools/admintech/force/generate

Deprecated (0)

Updates (12)

• [Monitoring - Alarms Details]
  • POST /alarms/markviewed
  • GET /alarms/purgefrequency
• [Monitoring - Alarms Notification]
  • GET /notifications/rules
• [Monitoring - Device Details]
  • GET /device
• [Monitoring - Health]
  • GET /health/devices
• [Monitoring - Search]
  • GET /v1/search
• [Monitoring - SiteHealth Monitor]
  • GET /statistics/sitehealth/common
• [Monitoring - Stats Download]
  • POST /statistics/download/{processType}/filelist
• [Real-Time Monitoring - BFD]
  • GET /device/bfd/sites/detail
• [Real-Time Monitoring - Interface]
  • GET /device/interface
  • GET /device/interface/synced
• [Troubleshooting Tools - Device Connectivity]
  • POST /device/tools/admintech

Breaking changes

The following are changes to the API that may break an application or integration.

[Monitoring - Alarms Details]

• GET /alarms/purgefrequency
  • API Operation Summary: Get alarm purge timer
  • ⛔️ Breaking Change - deleted the 'query' request parameter 'activeTime'
  • ⛔️ Breaking Change - deleted the 'query' request parameter 'interval'
  • ⛔️ Breaking Change - api operation id 'setPeriodicPurgeTimer' removed and replaced with 'getPeriodicPurgeTimer'

[Monitoring - Health]

• GET /health/devices
  • API Operation Summary: get the devices health properties
  • ⛔️ Breaking Change - for the 'query' request parameter 'personality', changed type/format from 'string'/'' to 'array'/''

[Monitoring - Search]

• GET /v1/search
  • API Operation Summary: Search a text
  • ⛔️ Breaking Change - the 'object' response's property type/format changed from ''/'string' to ''/'200' for status %!s(MISSING)

[Monitoring - Stats Download]

• GET /statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}
  • API Operation Summary: Downloading stats file
  • ⛔️ Breaking Change - Removed operation

New

The following operations are introduced with this release:

[Monitoring - Alarms Details]

• POST /alarms/purgefrequency
  • New operation: Set alarm purge timer

[Monitoring - Alarms Notification]

• POST /notifications/rule/{type}
  • New operation: Add notification rule by type
• PUT /notifications/rule/{type}
  • New operation: Update a specific notification rule by type

[Monitoring - CDP]

• GET /device/cdp/neighbors
  • New operation: Get CDP neighbors
• POST /device/cdp/neighbors
  • New operation: Get filtered CDP neighbors

[Monitoring - Device Configuration Security Advisories]

• GET /advisories/insecure-config/summary
  • New operation: Get advisories insecure summary

[Monitoring - LLDP]

• GET /device/lldp/neighbors
  • New operation: Get LLDP neighbors
• POST /device/lldp/neighbors
  • New operation: Get filtered LLDP neighbors

[Monitoring - Stats Download]

• GET /statistics/download/{processType}/file/{token}/{fileName}
  • New operation: Downloading stats file

[Real-Time Monitoring - BFD]

• GET /device/bfd/state/remoteSiteList
  • New operation: Get BFD remote site id list by local device site id

[Real-Time Monitoring - Cellular]

• GET /device/cellular/dyingGasp
  • New operation: Get cellular Dying-Gasp data from device
• GET /device/cellular/gps
  • New operation: Get cellular GPS data from device

[Real-Time Monitoring - Interface]

• GET /device/interface/config
  • New operation: Get device interfaces

[Real-Time Monitoring - Lpshield]

• GET /device/system/lpshield
  • New operation: Get device Lpshield

[Real-Time Monitoring - Next Generation Firewall Update Status]

• GET /device/ngfw/engine-status
  • New operation: Get Next Generation Firewall Engine Status
• GET /device/ngfw/lsp-update-status
  • New operation: Get Next Generation Firewall LSP Update Status
• GET /device/ngfw/vdb-update-status
  • New operation: Get Next Generation Firewall VDB Update Status
• GET /device/ngfw/version-status
  • New operation: Get Next Generation Firewall Version Status

[Real-Time Monitoring - Power Management]

• GET /device/powermgmt/status
  • New operation: Get Power Management Status Information

[Real-Time Monitoring - Power Management Daily History]

• GET /device/powermgmt/history/daily
  • New operation: Get Power Management Daily History Information

[Real-Time Monitoring - Power Management Hourly History]

• GET /device/powermgmt/history/hourly
  • New operation: Get Power Management Hourly History Information

[Real-Time Monitoring - QFP]

• GET /device/qfp/classificationmem
  • New operation: Get QFP classification memory
• GET /device/qfp/classificationtcam
  • New operation: Get QFP classification tcam

[Real-Time Monitoring - Switchport]

• GET /device/switchport
  • New operation: Get Switchport list from device (Real Time)

[Real-Time Monitoring - device/vlan]

• GET /device/vlan
  • New operation: Get native vlan list from device (Real Time)

[Troubleshooting Tools - Device Connectivity]

• POST /device/tools/admintech/delayed/cancel
  • New operation: Cancel delayed admin tech generation task
• POST /device/tools/admintech/force/generate
  • New operation: Force generate delayed admin tech logs

Deprecated

The following operations and properties will be removed in future releases. Therefore, it is not recommended to use these resources.

Updates

[Monitoring - Alarms Details]

• POST /alarms/markviewed
  • API Operation Summary: Mark alarms as acknowledged based on UUIDs. Supports at most 1000 UUID entries per request; duplicates are processed once.
  • added the new optional request property 'uuid'
• GET /alarms/purgefrequency
  • API Operation Summary: Get alarm purge timer
  • ⛔️ Breaking Change -deleted the 'query' request parameter 'activeTime'
  • ⛔️ Breaking Change -deleted the 'query' request parameter 'interval'
  • ⛔️ Breaking Change -api operation id 'setPeriodicPurgeTimer' removed and replaced with 'getPeriodicPurgeTimer'

[Monitoring - Alarms Notification]

• GET /notifications/rules
  • API Operation Summary: Get all rules or specific notification rule by its Id
  • added the new optional 'query' request parameter 'type'

[Monitoring - Device Details]

• GET /device
  • API Operation Summary: List all devices
  • added the new optional 'query' request parameter 'bfdSessions'
  • added the new optional 'query' request parameter 'bfdSessionsUp'
  • added the new optional 'query' request parameter 'board-serial'
  • added the new optional 'query' request parameter 'certificate-validity'
  • added the new optional 'query' request parameter 'connectedVManages'
  • added the new optional 'query' request parameter 'controlConnections'
  • added the new optional 'query' request parameter 'device-groups'
  • added the new optional 'query' request parameter 'device-model'
  • added the new optional 'query' request parameter 'device-os'
  • added the new optional 'query' request parameter 'device-type'
  • added the new optional 'query' request parameter 'deviceId'
  • added the new optional 'query' request parameter 'domain-id'
  • added the new optional 'query' request parameter 'health'
  • added the new optional 'query' request parameter 'host-name'
  • added the new optional 'query' request parameter 'isDeviceGeoData'
  • added the new optional 'query' request parameter 'lastupdated'
  • added the new optional 'query' request parameter 'latitude'
  • added the new optional 'query' request parameter 'layoutLevel'
  • added the new optional 'query' request parameter 'linux_cpu_count'
  • added the new optional 'query' request parameter 'local-system-ip'
  • added the new optional 'query' request parameter 'longitude'
  • added the new optional 'query' request parameter 'max-controllers'
  • added the new optional 'query' request parameter 'model_sku'
  • added the new optional 'query' request parameter 'multicloudPersonality'
  • added the new optional 'query' request parameter 'not'
  • added the new optional 'query' request parameter 'ompPeers'
  • added the new optional 'query' request parameter 'personality'
  • added the new optional 'query' request parameter 'platform'
  • added the new optional 'query' request parameter 'reachability'
  • added the new optional 'query' request parameter 'site-name'
  • added the new optional 'query' request parameter 'state'
  • added the new optional 'query' request parameter 'state_description'
  • added the new optional 'query' request parameter 'status'
  • added the new optional 'query' request parameter 'statusOrder'
  • added the new optional 'query' request parameter 'system-ip'
  • added the new optional 'query' request parameter 'testbed_mode'
  • added the new optional 'query' request parameter 'timezone'
  • added the new optional 'query' request parameter 'total_cpu_count'
  • added the new optional 'query' request parameter 'uptime-date'
  • added the new optional 'query' request parameter 'uuid'
  • added the new optional 'query' request parameter 'validity'
  • added the new optional 'query' request parameter 'version'
  • added the new optional 'query' request parameter 'vpnId'

[Monitoring - Health]

• GET /health/devices
  • API Operation Summary: get the devices health properties
  • ⛔️ Breaking Change -for the 'query' request parameter 'personality', changed type/format from 'string'/'' to 'array'/''
  • added the new optional 'query' request parameter 'chassis_number'
  • added the new optional 'query' request parameter 'serial_number'
  • added the new optional 'query' request parameter 'system_ip'
  • added the optional property 'devices/items/timeDiff' to the response with the '200' status
  • added the optional property 'devices/items/timeSyncMessage' to the response with the '200' status

[Monitoring - Search]

• GET /v1/search
  • API Operation Summary: Search a text
  • ⛔️ Breaking Change -the 'object' response's property type/format changed from ''/'string' to ''/'200' for status %!s(MISSING)
  • added the optional property '/items/results/items/identifiers' to the response with the '200' status
  • added the required property '/items/results/items/links/items/href' to the response with the '200' status

[Monitoring - SiteHealth Monitor]

• GET /statistics/sitehealth/common
  • API Operation Summary: sitehealth data
  • added the new optional 'query' request parameter 'bfd_state'

[Monitoring - Stats Download]

• POST /statistics/download/{processType}/filelist
  • API Operation Summary: Downloading list of stats file
  • added the non-success response with the status '507'

[Real-Time Monitoring - BFD]

• GET /device/bfd/sites/detail
  • API Operation Summary: Get detailed BFD site details
  • added the new optional 'query' request parameter 'vpnId'

[Real-Time Monitoring - Interface]

• GET /device/interface
  • API Operation Summary: Get device interfaces
  • added the new optional 'query' request parameter 'fec-mode'
  • added the new optional 'query' request parameter 'hwaddr'
• GET /device/interface/synced
  • API Operation Summary: Get device interfaces synchronously
  • added the new optional 'query' request parameter 'endTime'
  • added the new optional 'query' request parameter 'fec-mode'
  • added the new optional 'query' request parameter 'hwaddr'
  • added the new optional 'query' request parameter 'lastNHours'
  • added the new optional 'query' request parameter 'startTime'

[Troubleshooting Tools - Device Connectivity]

• POST /device/tools/admintech
  • API Operation Summary: Generate admin tech logs
  • added the new optional request property 'log-enable-setting'