{"type":"api","title":"Get Device Interface","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces","operationId":"getDeviceInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":18,"if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":13,"ifname":"ge0/1","rx-pps":14,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":2,"allow-service":"dhcp dns icmp https","if-tracker-status":"NA","num-flaps":"0","rx-packets":6544375,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":48131,"tx-drops":2,"uptime":"4:20:14:13","ipv6-address":"-","secondary":"false","ip-address":"10.101.3.3/16","hwaddr":"52:54:00:a1:4f:47","speed-mbps":"1000","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","tx-octets":1238809794,"tx-packets":6404951,"rx-octets":1209186254,"rx-kbps":19,"lastupdated":1643077714908,"port-type":"transport","uptime-date":1642659240000,"encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/1","rx-pps":0,"af-type":"ipv6","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ipv6-admin-status":"Up","ifindex":2,"allow-service":"dhcp dns icmp https","if-tracker-status":"NA","num-flaps":"0","rx-packets":3644,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"uptime":"4:20:14:13","ipv6-address":"-","hwaddr":"52:54:00:a1:4f:47","speed-mbps":"1000","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","tx-octets":9140,"tx-packets":128,"rx-octets":405455,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"transport","uptime-date":1642659240000,"encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/2","rx-pps":0,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Down","ifindex":3,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:39:5a:01","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/2","rx-pps":0,"af-type":"ipv6","shaping-rate":0,"if-oper-status":"Down","ipv6-admin-status":"Up","ifindex":3,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:39:5a:01","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/3","rx-pps":0,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Down","ifindex":4,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:2d:a0:f5","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read","method":"get","path":"/device/interface"}}