{"type":"api","title":"Create BFD History List","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 - BFD"],"description":"Get BFD session history from device (Real Time)","operationId":"createBFDHistoryList","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"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":"array","items":{"type":"object"}},"examples":{"BFD session history":{"description":"BFD session history","value":{"data":[{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"default","tx-pkts":3856,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187218000,"system-ip":"172.16.254.1","index":8,"dst-port":12386,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-8-2022-01-14T19:06:58+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:58+0000","state":"down","rx-pkts":3855},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"default","tx-pkts":6,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187218000,"system-ip":"172.16.254.1","index":9,"dst-port":12386,"del":1,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-9-2022-01-14T19:06:58+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:58+0000","state":"down","rx-pkts":6},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"biz-internet","tx-pkts":0,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187219000,"system-ip":"172.16.254.1","index":6,"dst-port":12406,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-6-2022-01-14T19:06:59+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:59+0000","state":"down","rx-pkts":0},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"biz-internet","tx-pkts":6,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187219000,"system-ip":"172.16.254.1","index":7,"dst-port":12406,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-7-2022-01-14T19:06:59+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:59+0000","state":"up","rx-pkts":6},{"dst-ip":"10.102.5.5","src-ip":"10.101.3.3","color":"default","tx-pkts":95431,"vdevice-name":"169.254.10.10","src-port":12346,"time-date":1642577832000,"system-ip":"172.16.254.4","index":8,"dst-port":12386,"del":0,"site-id":5,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-8-2022-01-19T07:37:12+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-19T07:37:12+0000","state":"down","rx-pkts":95426},{"dst-ip":"10.102.16.16","src-ip":"10.102.3.3","color":"lte","tx-pkts":0,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642163442000,"system-ip":"172.16.254.16","index":6,"dst-port":12366,"del":0,"site-id":16,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-6-2022-01-14T12:30:42+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T12:30:42+0000","state":"down","rx-pkts":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write","method":"get","path":"/device/bfd/history"}}