{"type":"api","title":"Create BFD Sessions","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 list of BFD sessions from vManage (Real Time)","operationId":"createBFDSessions","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":"local-color","in":"query","description":"Source 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":"region-type","in":"query","description":"Region type","schema":{"type":"string","enum":["core","access"]}},{"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 sessions":{"description":"BFD sessions","value":{"data":[{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.1","dst-port":12426,"site-id":2,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.1-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000},{"src-ip":"10.101.3.3","dst-ip":"10.101.4.4","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.3","dst-port":12386,"site-id":4,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.3-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000},{"src-ip":"10.101.3.3","dst-ip":"10.102.5.5","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.4","dst-port":12386,"site-id":5,"transitions":3,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:01:31:46","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.4-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642577820000},{"src-ip":"10.101.3.3","dst-ip":"10.102.6.6","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.5","dst-port":12386,"site-id":6,"transitions":2,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:01:36:07","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.5-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642577520000},{"src-ip":"10.101.3.3","dst-ip":"10.102.16.16","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.16","dst-port":12386,"site-id":16,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.16-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000}]}}}}}},"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/sessions"}}