Get version compliance across tenants - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get version compliance across tenants","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":"Get version compliance across tenants.","description":"Returns compliance information for the specified version of Controllers upgrade across all tenants.","operationId":"getVersionComplianceInfo","parameters":[{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with compliance information for the specified version.","content":{"application/json":{"schema":{"type":"object","properties":{"minimumControllerCompatibleVersion":{"type":"string","description":"Minimum compatible controller version"},"minimumDeviceCompatibleVersion":{"type":"string","description":"Minimum compatible device version"},"minimumValidatorCompatibleVersion":{"type":"string","description":"Minimum compatible validator version"},"nearNonCompliantDeviceCount":{"type":"integer","description":"Count of devices approaching non-compliance","format":"int32"},"nonCompliantControllersCount":{"type":"integer","description":"Count of non-compliant controllers","format":"int32"},"nonCompliantControllersCountLTSMinusOne":{"type":"integer","description":"Count of non-compliant controllers at LTS minus one version","format":"int32"},"nonCompliantControllersCountLTSMinusThree":{"type":"integer","description":"Count of non-compliant controllers at LTS minus three or lower versions","format":"int32"},"nonCompliantControllersCountLTSMinusTwo":{"type":"integer","description":"Count of non-compliant controllers at LTS minus two versions","format":"int32"},"nonCompliantControllersLTSMinusThree":{"type":"array","description":"List of non-compliant controllers at LTS minus three or lower versions","items":{"type":"object","properties":{"checkList":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"upgradeCompatibilityStatus":{"type":"string"}},"$$ref":"#/components/schemas/CheckList"}},"deviceDetails":{"required":["host","password","username","wan"],"type":"object","properties":{"device_uuid":{"type":"string","description":"device uuid/chassis number","example":"C8K-4facbd05-855b-45f0-af2f-c844af179bd6"},"enable_password":{"type":"string","description":"enable password","example":"admin"},"host":{"pattern":"((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))","type":"string","description":"host ip","example":"1.1.1.1"},"local_file_name":{"type":"string","description":"local file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"password":{"type":"string","description":"ssh password","example":"admin"},"remote_server_file_name":{"type":"string","description":"remote server file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"remote_server_id":{"type":"string","description":"remote server Id","example":"56a32849-aafb-4703-8887-ba64c0394835"},"username":{"type":"string","description":"ssh username","example":"admin"},"wan":{"maxLength":32,"minLength":3,"pattern":"(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)","type":"string","description":"WAN interface name","example":"GigabitEthernet1"}},"description":"Device list to onboard","$$ref":"#/components/schemas/DeviceDetails"},"status":{"type":"string"}},"description":"List of non-compliant validators at LTS minus three or lower versions","$$ref":"#/components/schemas/DeviceComplianceData"}},"nonCompliantDeviceCount":{"type":"integer","description":"Count of non-compliant devices","format":"int32"},"nonCompliantValidatorsCount":{"type":"integer","description":"Count of non-compliant validators","format":"int32"},"nonCompliantValidatorsCountLTSMinusOne":{"type":"integer","description":"Count of non-compliant validators at LTS minus one version","format":"int32"},"nonCompliantValidatorsCountLTSMinusThree":{"type":"integer","description":"Count of non-compliant validators at LTS minus three or lower versions","format":"int32"},"nonCompliantValidatorsCountLTSMinusTwo":{"type":"integer","description":"Count of non-compliant validators at LTS minus two versions","format":"int32"},"nonCompliantValidatorsLTSMinusThree":{"type":"array","description":"List of non-compliant validators at LTS minus three or lower versions","items":{"type":"object","properties":{"checkList":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"upgradeCompatibilityStatus":{"type":"string"}},"$$ref":"#/components/schemas/CheckList"}},"deviceDetails":{"required":["host","password","username","wan"],"type":"object","properties":{"device_uuid":{"type":"string","description":"device uuid/chassis number","example":"C8K-4facbd05-855b-45f0-af2f-c844af179bd6"},"enable_password":{"type":"string","description":"enable password","example":"admin"},"host":{"pattern":"((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))","type":"string","description":"host ip","example":"1.1.1.1"},"local_file_name":{"type":"string","description":"local file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"password":{"type":"string","description":"ssh password","example":"admin"},"remote_server_file_name":{"type":"string","description":"remote server file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"remote_server_id":{"type":"string","description":"remote server Id","example":"56a32849-aafb-4703-8887-ba64c0394835"},"username":{"type":"string","description":"ssh username","example":"admin"},"wan":{"maxLength":32,"minLength":3,"pattern":"(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)","type":"string","description":"WAN interface name","example":"GigabitEthernet1"}},"description":"Device list to onboard","$$ref":"#/components/schemas/DeviceDetails"},"status":{"type":"string"}},"description":"List of non-compliant validators at LTS minus three or lower versions","$$ref":"#/components/schemas/DeviceComplianceData"}},"tenantDetails":{"type":"array","description":"Tenant compliance details","items":{"type":"object","properties":{"nearNonCompliantDeviceCount":{"type":"integer","description":"Count of devices approaching non-compliance","format":"int32"},"nonCompliantDeviceCount":{"type":"integer","description":"Count of non-compliant devices","format":"int32"},"nonCompliantDevices":{"type":"array","description":"List of non-compliant devices","items":{"type":"object","properties":{"checkList":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"upgradeCompatibilityStatus":{"type":"string"}},"$$ref":"#/components/schemas/CheckList"}},"deviceDetails":{"required":["host","password","username","wan"],"type":"object","properties":{"device_uuid":{"type":"string","description":"device uuid/chassis number","example":"C8K-4facbd05-855b-45f0-af2f-c844af179bd6"},"enable_password":{"type":"string","description":"enable password","example":"admin"},"host":{"pattern":"((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))","type":"string","description":"host ip","example":"1.1.1.1"},"local_file_name":{"type":"string","description":"local file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"password":{"type":"string","description":"ssh password","example":"admin"},"remote_server_file_name":{"type":"string","description":"remote server file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"remote_server_id":{"type":"string","description":"remote server Id","example":"56a32849-aafb-4703-8887-ba64c0394835"},"username":{"type":"string","description":"ssh username","example":"admin"},"wan":{"maxLength":32,"minLength":3,"pattern":"(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)","type":"string","description":"WAN interface name","example":"GigabitEthernet1"}},"description":"Device list to onboard","$$ref":"#/components/schemas/DeviceDetails"},"status":{"type":"string"}},"description":"List of non-compliant validators at LTS minus three or lower versions","$$ref":"#/components/schemas/DeviceComplianceData"}},"tenantId":{"type":"string","description":"Tenant ID"},"tenantName":{"type":"string","description":"Tenant name"}},"description":"Tenant compliance details","$$ref":"#/components/schemas/TenantCompliance"}},"version":{"type":"string","description":"Software version number"}},"description":"Version compliance information across all tenants","$$ref":"#/components/schemas/VersionComplianceInfoResponse"},"examples":{"Version 20.18.999":{"summary":"Example response for version 20.18.999","description":"Version 20.18.999","value":{"version":"20.18.999","minimumControllerCompatibleVersion":"20.18","minimumValidatorCompatibleVersion":"20.18","minimumDeviceCompatibleVersion":"17.12","nonCompliantControllersCount":0,"nonCompliantControllersCountLTSMinusOne":0,"nonCompliantControllersCountLTSMinusTwo":0,"nonCompliantControllersCountLTSMinusThree":0,"nonCompliantValidatorsCount":0,"nonCompliantValidatorsCountLTSMinusOne":0,"nonCompliantValidatorsCountLTSMinusTwo":0,"nonCompliantValidatorsCountLTSMinusThree":0,"nonCompliantDeviceCount":2,"nearNonCompliantDeviceCount":0,"tenantDetails":[{"tenantName":"Default","tenantId":"default","nonCompliantDevices":[{"hostname":"vm11","systemIp":"172.16.255.21","siteId":"100","siteName":"SITE_100","uuid":"9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea","chassisNumber":"9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea","reachability":"reachable","platform":"x86_64","deviceType":"vedge","personality":"vedge","currentVersion":"20.9.6-957"},{"hostname":"vm4","systemIp":"172.16.255.14","siteId":"400","siteName":"SITE_400","uuid":"add106e3-be72-4ddb-88d4-f07108b1ef12","chassisNumber":"add106e3-be72-4ddb-88d4-f07108b1ef12","reachability":"reachable","platform":"x86_64","deviceType":"vedge","personality":"vedge","currentVersion":"20.9.6-957"}],"nonCompliantDeviceCount":2,"nearNonCompliantDeviceCount":0}]}},"Version 20.25.999":{"summary":"Example response for version 20.25.999","description":"Version 20.25.999","value":{"version":"20.25.999","minimumControllerCompatibleVersion":"20.25","minimumValidatorCompatibleVersion":"20.25","minimumDeviceCompatibleVersion":"17.21","nonCompliantControllersCount":1,"nonCompliantControllersCountLTSMinusOne":0,"nonCompliantControllersCountLTSMinusTwo":0,"nonCompliantControllersCountLTSMinusThree":1,"nonCompliantValidatorsCount":1,"nonCompliantValidatorsCountLTSMinusOne":0,"nonCompliantValidatorsCountLTSMinusTwo":0,"nonCompliantValidatorsCountLTSMinusThree":1,"nonCompliantDeviceCount":1,"nearNonCompliantDeviceCount":0,"tenantDetails":[{"tenantName":"Default","tenantId":"default","nonCompliantDevices":[{"hostname":"vm11","systemIp":"172.16.255.21","siteId":"100","siteName":"SITE_100","uuid":"9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea","chassisNumber":"9dd1e23f-3c21-4c93-ade3-6fb7b7cbe0ea","reachability":"reachable","platform":"x86_64","deviceType":"vedge","personality":"vedge","currentVersion":"20.9.6-957"}],"nonCompliantDeviceCount":1,"nearNonCompliantDeviceCount":0}],"nonCompliantControllersLTSMinusThree":[{"hostname":"vm10","systemIp":"172.16.255.20","siteId":"200","siteName":"SITE_200","uuid":"a5af47b2-b257-4831-93bd-ef7911cc47f4","chassisNumber":"a5af47b2-b257-4831-93bd-ef7911cc47f4","reachability":"reachable","platform":"x86_64","deviceType":"vsmart","personality":"vsmart","currentVersion":"20.18.999-4446"}],"nonCompliantValidatorsLTSMinusThree":[{"hostname":"vm16","systemIp":"172.16.255.26","siteId":"-","siteName":"-","uuid":"48a73b3b-1b97-42de-9128-5bab93ba614c","chassisNumber":"48a73b3b-1b97-42de-9128-5bab93ba614c","reachability":"reachable","platform":"x86_64","deviceType":"vbond","personality":"vbond","currentVersion":"20.18.999-4446"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/v1/controllers-upgrade/version-compliance-info"}}