{"type":"api","title":"Start Software Upgrade","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"consumes":["application/json"],"description":"Start Software Upgrade of Base firmware or AP module firmware on a max of upto 2500 devices at a time\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices\u003cbr /\u003e- Manage Firmware Upgrades\u003cbr /\u003e- Manage Groups","operationId":"startSoftwareUpgrade","parameters":[{"description":"UUID of the organization with devices where Software upgrade needs to be initiated.","format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"in":"body","name":"body","schema":{"properties":{"deviceEids":{"description":"Device Eids\u003cbr /\u003eUse GET /devices API to view list of available devices and specify the eid of the selected device(s) for software upgrade.\u003cbr /\u003eIf groupId is not specified and deviceEids is specified, then software upgrade is scheduled for all the devices whose Eid is specified.","items":{"example":"IR829M-LTE-EA-AK9+FADIR829AK9","type":"string"},"type":"array"},"enableImageDiff":{"default":false,"description":"Enable image diff","type":"boolean"},"enableIox":{"default":true,"description":"Enable Iox","type":"boolean"},"enableWPAN":{"default":false,"description":"Enable WPAN","type":"boolean"},"forceLoraInstall":{"default":false,"description":"Force LORA Install","type":"boolean"},"groupId":{"description":"Unique Group Id \u003cbr /\u003eUse GET /groups API to view list of available groups and specify the id of the selected group for software upgrade. \u003cbr /\u003eIf groupId is specified, then software upgrade is scheduled for all the devices in the specified group.","example":37001,"type":"integer"},"imageId":{"description":"Software Image Id.\u003cbr /\u003eUse GET /software/image API to view list of available software images and specify the id of the selected image for software upgrade.","example":5301,"type":"integer"},"jobDescription":{"description":"Job description","example":null,"type":"string"},"jobName":{"description":"Job name","example":"ir829-one-fw-upgrade","type":"string"},"operationType":{"description":"Software Upgrade action to be performed.\u003cbr /\u003eMust be one of the values - Upload, Install or Upload_Install","enum":["Upload","Install","Upload_Install"],"example":"Upload","type":"string"},"scheduleFor":{"description":"Schedule Software Upgrade for the specified time in the format yyyy-MM-dd hh:mm:ss","example":null,"type":"string"}},"required":["operationType"],"type":"object","$$ref":"#/definitions/SoftwareUpgradeRequest"}}],"produces":["application/json"],"responses":{"202":{"description":"successfully accepted","schema":{"properties":{"jobId":{"example":7126547189,"format":"int64","type":"integer"},"jobOpUid":{"type":"string"},"message":{"type":"string"}},"type":"object","$$ref":"#/definitions/SoftwareUpgradeResponse"}},"400":{"description":"Bad request","schema":{"description":"Specifies the error that occurred during the request.","example":{"code":"10000","message":"Short message about the error","meta":"more information about that error"},"properties":{"code":{"description":"The error code that occurred in application level.","type":"number"},"message":{"description":"A user readable message that describes the error in details.","type":"string"},"meta":{"description":"Contains more information about the error message. For example when a validation error occurs, this field describes the fields that were invalid and the validation error that occurred. The content of this object can vary based on the type of error.\n","type":"object"}},"required":["code","message"],"type":"object","$$ref":"#/definitions/error"}},"401":{"description":"Unauthorized","schema":{"example":"Unauthorized","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Not found","schema":{"example":"Image not found","type":"string"}}},"summary":"Start Software Upgrade on devices","tags":["groups"],"__originalOperationId":"startSoftwareUpgrade","security":[{"bearerAuth":[]}],"method":"post","path":"/groups/software_upgrade"}}