Skip to content
Catalyst SD-WAN APIs

Real-Time Monitoring APIs

Real-time APIs query current operational state directly from a selected WAN Edge device. Use them for targeted troubleshooting when you need the device’s latest view rather than stored history.

Real-Time Monitoring Domains

Section titled “Real-Time Monitoring Domains”

The 26.1 OpenAPI specification contains hundreds of /device operations across routing, transport, security, system, and platform domains.

Application-Aware Routing

Inspect SLA classes and current application-route measurements such as latency, loss, and jitter.

Routing and Sessions

Inspect ARP, BFD, BGP, OMP, OSPF, IPsec, and control connections.

Interfaces and Tunnels

Read interface state, counters, errors, queues, tunnel statistics, and transport state.

System and Platform

Read system status, CPU and memory information, hardware state, software, NTP, and logs.

Representative Endpoints

Section titled “Representative Endpoints”
Category Method and endpoint Purpose
SLA Class GET /device/app-route/sla-class?deviceId={system-ip} Display SLA classes operating on the router
Application-Aware Routing GET /device/app-route/statistics?deviceId={system-ip} Read live application-route statistics; optionally filter by peer and colors
ARP GET /device/arp?deviceId={system-ip} Read the device ARP table
BFD GET /device/bfd/sessions?deviceId={system-ip} Read current BFD sessions; optionally filter by peer, color, or region type
Data-plane statistics GET /device/sdwan-stats?deviceId={system-ip} Read current SD-WAN data-plane statistics
Interfaces GET /device/interface?deviceId={system-ip} Read interface state and counters; optionally filter by VPN, interface, or address family
System GET /device/system/status?deviceId={system-ip} Read current CPU, uptime, and system status

The required deviceId query parameter is the device system IP, not its chassis UUID.

Inspect BFD Sessions

Section titled “Inspect BFD Sessions”
GET/device/bfd/sessions?deviceId=10.0.0.20Read current BFD sessions
Headers
X-XSRF-TOKEN: <X-XSRF-TOKEN>
Authorization: Bearer {{apikey}}
Content-Type: application/json

Request body

Empty — this operation uses query parameters.

Response - 200 OK

{
  "data": [
    {
      "vdevice-name": "169.254.10.10",
      "system-ip": "172.16.254.1",
      "local-color": "default",
      "color": "default",
      "proto": "ipsec",
      "state": "up"
    }
  ]
}

Read Application-Route Statistics

Section titled “Read Application-Route Statistics”
GET/device/app-route/statistics?deviceId=10.0.0.20&local-color=biz-internetRead live application-route measurements
Headers
X-XSRF-TOKEN: <X-XSRF-TOKEN>
Authorization: Bearer {{apikey}}
Content-Type: application/json

Request body

Empty — this operation uses query parameters.

Response - 200 OK

{
  "data": [
    {
      "vdevice-name": "169.254.10.10",
      "remote-system-ip": "172.16.254.1",
      "local-color": "default",
      "remote-color": "default",
      "mean-latency": 0,
      "mean-loss": 0,
      "mean-jitter": 0
    }
  ]
}

Practice with Bruno

Section titled “Practice with Bruno”

After completing authentication, run these requests from the Monitoring APIs folder:

  1. 01 - Real-Time BFD Sessions reads current BFD session state from the device selected by system_ip.
  2. 02 - Real-Time Application-Route Statistics reads the device’s current application-aware routing measurements.

No post-response ID scripts are needed because these operations only read data.

Try It with Python

Section titled “Try It with Python”
Terminal window
uv run -m monitoring.run_cases --insecure system-status
uv run -m monitoring.run_cases --insecure interfaces
uv run -m monitoring.run_cases --insecure tunnel-traffic

See Python Monitoring Examples for device selection and reusable case definitions.

Next Steps

Section titled “Next Steps”