{"type":"api","title":"Claim Devices","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Device Inventory"],"description":"Claim the selected unclaimed devices","operationId":"claimDevices","requestBody":{"description":"Claim device request","content":{"application/json":{"schema":{"type":"object","properties":{"chassis_list":{"type":"array","items":{"type":"object","properties":{"chassis-serial-number":{"type":"string","example":"SSI130300YK"},"configuredAaaUser":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"C8000v"},"device-os":{"type":"string","example":"next"},"device-type":{"type":"string","example":"vedge"},"deviceId":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"devicesAttached":{"type":"integer","format":"int32","example":0},"discoveredDeviceInterfaces":{"type":"array","items":{"type":"string"}},"host-name":{"type":"string","example":"vm5"},"loopback":{"type":"array","items":{"type":"object","properties":{"interfaceIP":{"type":"string","example":"127.0.0.1"},"interfaceName":{"type":"string","example":"Loopback0"}},"$$ref":"#/components/schemas/Loopback"}},"personality":{"type":"string","example":"vedge"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable","enum":["reachable","unreachable"]},"registrationDate":{"type":"integer","format":"int64","example":1590186370340},"serialNumber":{"type":"string","example":"12345712"},"site-id":{"type":"string","example":"500"},"state":{"type":"string","example":"green"},"status":{"type":"string","example":"normal","enum":["error","warning","normal","new"]},"system-ip":{"type":"string","example":"172.16.255.15"},"templateStatus":{"type":"string","example":"Success"},"uuid":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"validity":{"type":"string","example":"valid","enum":["invalid","staging","valid","prestaging"]},"version":{"type":"string","example":"17.06.01.0.1422"},"wanInterfaces":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/Device"}},"organization":{"type":"string"},"validityString":{"type":"string"}},"$$ref":"#/components/schemas/ClaimDevicesRequest"},"examples":{"Claim device request":{"description":"Claim device request","value":{"organization":"srikann-viptela","validityString":"valid","chassis_list":[{"chassis-number":"ISR4351/K9-FDO23070Y63","serial-number":"383CB73","subject-serial-number":"FDO23070Y63"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiRequestExampleClaimdevices"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"activityList":{"type":"string","example":"[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassis Id, serial number): , - ISR4351/K9-FDO23070Y63, 383CB73]"},"id":{"type":"string","example":"7d77139d-5bed-4e82-8ea5-411a588a522e"},"vedgeListUploadMsg":{"type":"string","example":" of vEdges uploaded successfully: 1"},"vedgeListUploadStatus":{"type":"string","example":"vEdge list uploaded successfully"}},"$$ref":"#/components/schemas/ClaimDevicesResponse"},"examples":{"Claimed device info":{"description":"Claimed device info","value":{"vedgeListUploadMsg":" of vEdges uploaded successfully: 1","vedgeListUploadStatus":"vEdge list uploaded successfully","id":"7d77139d-5bed-4e82-8ea5-411a588a522e","activityList":"[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassis Id, serial number): , - ISR4351/K9-FDO23070Y63, 383CB73]"},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceconfigSystemDeviceSystemdeviceapiResponseExampleClaimdevicesresp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/system/device/claimDevices"}}