{"type":"api","title":"Retrieve detailed controllers upgrade status","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":["Workflows - Controllers Upgrade"],"summary":"Retrieve detailed controllers upgrade status.","description":"Retrieve detailed upgrade status of controllers by providing process Id.","operationId":"getUpgradeStatus","parameters":[{"name":"processId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with detailed upgrade status.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the operation (Cancel/Reschedule)"},"statusDetail":{"type":"string","description":"Detailed description of the operation (Cancel/Reschedule) result"}},"$$ref":"#/components/schemas/ControllersOperationResponse"},"examples":{"Sample Response":{"description":"Sample Response","value":{"validation":{"processId":"controllers_patch_upgrade-18a1ba4e-743f-4f47-91b2-c2babb4f3c60","uuid":"Validation","status":"Validation success","totalChecksPerDevice":4,"activity":[{"stage-name":"Validation","checks":[{"check-name":"Active Tasks","status":"Success","details":"No active tasks found"},{"check-name":"Version Compatibility","status":"Success","details":"Version Compatibility check completed"},{"check-name":"Impacted Controller Types","status":"Success","details":"Validating impacted controller types check completed"},{"check-name":"Summary","status":"Success","details":"All validation checks completed"}],"noOfChecks":4,"status":"Validation success"}]},"preparation":{"processId":"controllers_patch_upgrade-18a1ba4e-743f-4f47-91b2-c2babb4f3c60","uuid":"Preparation","status":"Success","totalChecksPerDevice":3,"activity":[{"stage-name":"Preparation","checks":[{"check-name":"Image Availability","status":"success","details":"Found patch upgrade image in local repository for version 20.17.1.0.0.2"},{"check-name":"Launch UC Service","status":"success","details":"Manager has successfully started NMS Upgrade Coordinator for patch upgrade"},{"check-name":"Summary","status":"success","details":"Preparation done successfully"}],"noOfChecks":3,"status":"Success"}]},"data":[{"processId":"controllers_patch_upgrade-18a1ba4e-743f-4f47-91b2-c2babb4f3c60","uuid":"00fe3eb9-1ead-4237-b48f-2fd5f48bcac7","device-type":"vbond","host-name":"vm16","system-ip":"172.16.255.26","site-id":"100","status":"Failure","totalChecksPerDevice":31,"activity":[{"stage-name":"preDownloadCheck","checks":[{"check-name":"Checking Certification expiry","status":"Success","details":"Device certificate is valid"},{"check-name":"Checking device reachability","status":"Success","details":"Device is reachable"},{"check-name":"disk-space-check","status":"Success","details":"Sufficient space in /boot partition. Required space: 3266560 bytes, Available space: 2292785152 bytes ,remediation:No Remediation required"},{"check-name":"version-check","status":"Failure","details":"Patch version Check Failed ,remediation:Patch major version mismatch"},{"check-name":"memory-usage-check","status":"Success","details":"System has healthy Memory levels ,remediation:No remediation needed"},{"check-name":"cpu-load-check","status":"Success","details":"System has healthy CPU levels ,remediation:No remediation needed"},{"check-name":"precheck-fail","status":"Warning","details":"Finished Pre-Download image check and Failed ,remediation:Fix the errors and try again"}],"noOfChecks":8,"status":"Failure"}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/v1/controllers-upgrade/status"}}