{"type":"api","title":"Upgrade Protocol Pack","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":["Protocol Pack Maintenance"],"description":"Deploy protocol pack to devices","operationId":"upgradeProtocolPack","requestBody":{"description":"Request Payload","content":{"application/json":{"schema":{"type":"object","properties":{"autoUpgradeInCompatibleDevices":{"type":"boolean"},"deviceSelectionType":{"type":"string","enum":["entire-network","selected-devices"]},"devices":{"type":"array","items":{"type":"string"}},"executionType":{"type":"string","enum":["now","later"]},"protocolPackType":{"type":"string","enum":["selected-protocol-pack","default-protocol-pack","built-in-protocol-pack"]},"protocolPacks":{"type":"array","items":{"type":"string"}},"scheduleTime":{"type":"integer","format":"int64"}},"$$ref":"#/components/schemas/ProtocolPackUpgradeRequest"},"examples":{"Selected Devices, selective protocol pack, scheduled now":{"description":"Selected Devices, selective protocol pack, scheduled now","value":{"deviceSelectionType":"selected-devices","scheduleTime":0,"devices":["172.16.255.11"],"executionType":"now","protocolPacks":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackType":"selected-protocol-pack"}},"Selected Devices, default protocol pack, scheduled now":{"description":"Selected Devices, default protocol pack, scheduled now","value":{"deviceSelectionType":"selected-devices","scheduleTime":0,"devices":["172.16.255.11"],"executionType":"now","protocolPacks":[],"protocolPackType":"default-protocol-pack"}},"Selected Devices, built-in protocol pack, scheduled now":{"description":"Selected Devices, built-in protocol pack, scheduled now","value":{"deviceSelectionType":"selected-devices","scheduleTime":0,"devices":["172.16.255.11"],"executionType":"now","protocolPacks":[],"protocolPackType":"built-in-protocol-pack"}},"All Devices, selective protocol pack, scheduled now":{"description":"All Devices, selective protocol pack, scheduled now","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","protocolPacks":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackType":"selected-protocol-pack"}},"All Devices, default protocol pack, scheduled now":{"description":"All Devices, default protocol pack, scheduled now","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","protocolPacks":[],"protocolPackType":"default-protocol-pack"}},"All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Enabled":{"description":"All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Enabled","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","autoUpgradeInCompatibleDevices":true,"protocolPacks":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackType":"selected-protocol-pack"}},"All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Disabled":{"description":"All Devices, selective protocol pack, scheduled now, with Auto Upgrade Flag Disabled","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","autoUpgradeInCompatibleDevices":false,"protocolPacks":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackType":"selected-protocol-pack"}},"All Devices, built-in protocol pack, scheduled now":{"description":"All Devices, built-in protocol pack, scheduled now","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","protocolPacks":[],"protocolPackType":"built-in-protocol-pack"}},"Scheduled Upgrade":{"description":"Scheduled Upgrade","value":{"deviceSelectionType":"entire-network","scheduleTime":1706803770000,"devices":[],"executionType":"later","protocolPacks":[],"protocolPackType":"default-protocol-pack"}}}}},"required":true},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"type":"object"},"examples":{"Response":{"description":"Response","value":{"taskExtraKey":"vIPtela Inc Regression","deployScheduleTime":0,"protocolPackName":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackNameSelectionType":"selected-protocol-pack","uuid":"436201f9-c701-4556-8404-2adcde645d3f","status":"scheduled","taskId":"sdavc_deploy_protocol_pack_on_device-436201f9-c701-4556-8404-2adcde645d3f","message":"Deploy Protocol Pack on Device initiated for : vIPtela Inc Regression","segmentName":"vIPtela Inc Regression"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"\u003cShort Message\u003e","code":"PP0001","details":"\u003cDetailed Message\u003e"}}}}}}}},"method":"post","path":"/sdavc/protocol-pack/maintenance/upgrade"}}