{"type":"api","title":"Retrieve available versions for 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":"Retrieve available versions for Controllers upgrade.","description":"Returns a list of available versions for controller upgrades based on the specified image type.","operationId":"getAvailableVersions","parameters":[{"name":"imageType","in":"query","required":true,"schema":{"type":"string","description":"software: Supports vmanage/viptela images\npatch: Supports 6 tuple patch images","enum":["upgrade","patch"]}}],"responses":{"200":{"description":"Successful response with the list of available versions.","content":{"application/json":{"schema":{"type":"object","properties":{"availableVersions":{"type":"array","description":"List of available versions for controller upgrades","items":{"type":"object","properties":{"compatibleControllerTypes":{"uniqueItems":true,"type":"array","description":"Set of controller types compatible with this version","example":["Manager","Controller","Validator"],"items":{"type":"string","description":"Set of controller types compatible with this version","example":["Manager","Controller","Validator"]}},"imageType":{"uniqueItems":true,"type":"array","description":"Set of supported controller types for this image","example":["Manager","Controller","Validator"],"items":{"type":"string","description":"Set of supported controller types for this image","example":["Manager","Controller","Validator"]}},"location":{"type":"string","description":"Location of the image","example":"cco","enum":["cco","vmanage"]},"tag":{"type":"string","description":"Version tag indicating version status","example":"recommended","enum":["recommended","latest","custom"]},"version":{"type":"string","description":"Software version number"}},"description":"Version information for controllers upgrade","$$ref":"#/components/schemas/VersionInfo"}}},"description":"Response containing available controller software versions","$$ref":"#/components/schemas/AvailableVersionsResponse"},"examples":{"ExampleUpgradePayload":{"description":"ExampleUpgradePayload","value":"{\n\"availableVersions\": [\n {\n \"version\": \"20.15.2\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"recommended\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"]\n },\n {\n \"version\": \"20.17.1\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"latest\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"]\n },\n {\n \"version\": \"20.17.1\",\n \"imageType\": [\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Controller\",\"Validator\"],\n },\n {\n \"version\": \"20.17.2\",\n \"imageType\": [\"Manager\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\"],\n },\n {\n \"version\": \"20.17.3\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"],\n }\n]\n}"},"ExamplePatchPayload":{"description":"ExamplePatchPayload","value":"{\n\"availableVersions\": [\n {\n \"version\": \"20.17.2.1.2.3\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"recommended\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"],\n },\n {\n \"version\": \"20.17.1.0.0.1\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"cco\",\n \"tag\": \"latest\",\n \"compatibleControllerTypes\": [\"Controller\",\"Validator\"],\n },\n {\n \"version\": \"20.17.1.1.0.0\",\n \"imageType\": [\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Validator\"],\n },\n {\n \"version\": \"20.17.2.0.1.0\",\n \"imageType\": [\"Manager\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\"],\n },\n {\n \"version\": \"20.17.3.1.1.1\",\n \"imageType\": [\"Manager\",\"Controller\",\"Validator\"],\n \"location\": \"vmanage\",\n \"tag\": \"custom\",\n \"compatibleControllerTypes\": [\"Manager\",\"Controller\",\"Validator\"],\n }\n]\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/v1/controllers-upgrade/available-versions"}}