{"type":"api","title":"GET Manual Onboard Device details","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"summary":"GET Manual Onboard Device details","description":"GET Manual Onboard Device details","operationId":"getDevices","parameters":[{"name":"status","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"required":["devices"],"type":"object","properties":{"devices":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Device list to onboard","items":{"required":["host","password","username","wan"],"type":"object","properties":{"device_uuid":{"type":"string","description":"device uuid/chassis number","example":"C8K-4facbd05-855b-45f0-af2f-c844af179bd6"},"enable_password":{"type":"string","description":"enable password","example":"admin"},"host":{"pattern":"((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))","type":"string","description":"host ip","example":"1.1.1.1"},"local_file_name":{"type":"string","description":"local file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"password":{"type":"string","description":"ssh password","example":"admin"},"remote_server_file_name":{"type":"string","description":"remote server file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"remote_server_id":{"type":"string","description":"remote server Id","example":"56a32849-aafb-4703-8887-ba64c0394835"},"username":{"type":"string","description":"ssh username","example":"admin"},"wan":{"maxLength":32,"minLength":3,"pattern":"(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)","type":"string","description":"WAN interface name","example":"GigabitEthernet1"}},"description":"Device list to onboard","$$ref":"#/components/schemas/DeviceDetails"}}},"$$ref":"#/components/schemas/DeviceDetailsData"},"$$ref":"#/components/schemas/Details"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"getDevices","method":"get","path":"/onboard/devices"}}