{"type":"api","title":"Process Install","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 Actions"],"description":"Process an installation operation","operationId":"processInstall","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"required":["action"],"type":"object","properties":{"action":{"type":"string","example":"install"},"actionEnd":{"type":"string","description":"Scheduled time for the action to end.","example":"Wed Nov 06 2024 15:27:32"},"actionEndMillis":{"type":"integer","description":"Scheduled time in EPHOC millis for the action to end.","format":"int32","example":1730887052000},"actionStart":{"type":"string","description":"Scheduled time for the action to start.","example":"Wed Nov 06 2024 11:27:32"},"actionStartMillis":{"type":"integer","description":"Scheduled time in EPHOC millis for the action to start.","format":"int32","example":1730872652000},"deviceType":{"type":"string","example":"vedge"},"devices":{"type":"array","items":{"required":["deviceIP","deviceId"],"type":"object","properties":{"deviceIP":{"type":"string","description":"Device IP address.","example":"172.16.255.14"},"deviceId":{"type":"string","description":"Device ID.","example":"2f876a33-9944-450a-91ee-f1f80eb68348"}},"$$ref":"#/components/schemas/ProcessInstallReqDevices"}},"input":{"required":["data","vEdgeVPN","vSmartVPN","versionType"],"type":"object","properties":{"data":{"type":"array","description":"Device action input data.","items":{"required":["family","version"],"type":"object","properties":{"family":{"type":"string","description":"Platform family of the software image.","example":"c800v"},"version":{"type":"string","description":"Version of the software image.","example":"17.17.01.0.209664.1728238032"},"versionId":{"type":"string","description":"Version id of the software image.","example":"824ac3d6-7d2a-4dfa-8a8b-e6e5bc64acb8"}},"description":"Device action input data.","$$ref":"#/components/schemas/ProcessInstallReqInputData"}},"reboot":{"type":"boolean","example":false},"sync":{"type":"boolean","example":true},"vEdgeVPN":{"type":"integer","description":"VPN id of the vEdge.","format":"int32","example":0},"vSmartVPN":{"type":"integer","description":"VPN id of the vSmart.","format":"int32","example":0},"versionType":{"type":"string","description":"Version type of the software image.","example":"vmanage"}},"$$ref":"#/components/schemas/ProcessInstallReqInput"},"timeZone":{"type":"string","description":"Scheduled time zone for the action.","example":"UTC"}},"$$ref":"#/components/schemas/ProcessInstallReq"},"examples":{"Example Value":{"description":"Example Value","value":{"action":"install","input":{"vEdgeVPN":0,"vSmartVPN":0,"data":[{"family":"c8000v","version":"17.17.01.0.209664.1728238032","versionId":"824ac3d6-7d2a-4dfa-8a8b-e6e5bc64acb8"}],"versionType":"vmanage","reboot":false,"sync":true},"devices":[{"deviceIP":"172.16.255.14","deviceId":"2f876a33-9944-450a-91ee-f1f80eb68348"}],"deviceType":"vedge"},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiRequestExampleInstall"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"software_install-01232017T154359940"},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceactionDeviceactionapiResponseExampleInstallresppost"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/device/action/install"}}