{"type":"api","title":"Trigger controllers upgrade","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":"Trigger controllers upgrade.","description":"Trigger controllers upgrade.","operationId":"triggerControllersUpgrade","requestBody":{"description":"Request payload for controllers upgrade","content":{"application/json":{"schema":{"required":["action","imageLocation","isScheduleNow","targetVersion"],"type":"object","properties":{"action":{"type":"string","description":"Action to perform","example":"controllers_upgrade/controllers_patch_upgrade"},"applicableControllerTypes":{"type":"array","description":"List of controller types applicable for patch upgrade","example":["Manager","Controller","Validator"],"items":{"type":"string","description":"List of controller types applicable for patch upgrade","example":["Manager","Controller","Validator"]}},"imageLocation":{"type":"string","description":"Image location","example":"vmanage/cco"},"isScheduleNow":{"type":"boolean","description":"Flag to schedule the upgrade immediately","example":false},"schedule":{"type":"object","additionalProperties":{"type":"object","properties":{"actionStartDate":{"type":"string","description":"Start date for the action","example":"Sep 30 2026"},"actionStartTime":{"type":"string","description":"Start time for the action","example":"12:00:00 AM"},"timeZone":{"type":"string","description":"Timezone for the scheduled action","example":"Asia/Kolkata"}},"description":"Scheduling details for a controller component","$$ref":"#/components/schemas/ComponentSchedule"},"description":"Scheduling details for different component types"},"targetVersion":{"type":"string","description":"Target version for upgrade","example":"20.18.1"}},"description":"Request payload for controllers upgrade process","$$ref":"#/components/schemas/ControllerUpgradeRequest"},"examples":{"Schedule Now Controllers Upgrade":{"description":"Schedule Now Controllers Upgrade","value":{"action":"controllers_upgrade","targetVersion":"20.18.1","imageLocation":"vmanage/cco","isScheduleNow":true}},"Schedule Later Controllers Upgrade":{"description":"Schedule Later Controllers Upgrade","value":{"action":"controllers_upgrade","targetVersion":"20.18.1","imageLocation":"vmanage/cco","isScheduleNow":false,"schedule":{"Controller":{"actionStartDate":"Sep 30 2026","actionStartTime":"12:00:00 AM","timeZone":"Asia/Kolkata"},"Manager":{"actionStartDate":"Sep 30 2026","actionStartTime":"12:00:00 AM","timeZone":"Asia/Kolkata"},"Validator":{"actionStartDate":"Sep 30 2026","actionStartTime":"12:00:00 AM","timeZone":"Asia/Kolkata"}}}},"Schedule Now Patch Upgrade":{"description":"Schedule Now Patch Upgrade","value":{"action":"controllers_patch_upgrade","targetVersion":"20.18.1.0.0.1","imageLocation":"vmanage/cco","isScheduleNow":true,"applicableControllerTypes":["Manager","Controller","Validator"]}},"Schedule Later Patch Upgrade":{"description":"Schedule Later Patch Upgrade","value":{"action":"controllers_patch_upgrade","targetVersion":"20.18.1.0.0.1","imageLocation":"vmanage/cco","isScheduleNow":false,"applicableControllerTypes":["Manager","Controller","Validator"],"schedule":{"Controller":{"actionStartDate":"Sep 30 2026","actionStartTime":"12:00:00 AM","timeZone":"Asia/Kolkata"},"Manager":{"actionStartDate":"Sep 30 2026","actionStartTime":"12:00:00 AM","timeZone":"Asia/Kolkata"},"Validator":{"actionStartDate":"Sep 30 2026","actionStartTime":"12:00:00 AM","timeZone":"Asia/Kolkata"}}}}}}},"required":true},"responses":{"200":{"description":"Successful response with the controllers upgrade process Id.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique process Id of the Controllers upgrade.","example":"controllers_upgrade-0ba19b6e-3b6c-4cd0-9669-dce7e148c623"}},"$$ref":"#/components/schemas/ControllersUpgradeResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/v1/controllers-upgrade"}}