Get OS

Download the latest version of OS by a given id

Syntax: see Call Structure

Type = 'GET'

\'http://localhost:43430/api/v1/devices/id/os/download?version=version' \

Parameter	Description
id	This is a unique identifier returned from Get Devices
version	One of the available versions below

Version	Description
latest	The newest release version available
current	The same as the current version of OS on the device
Beta	The newest beta version available

Returns:

{

"result": {

"id": "id",

"code": 0,

"message": "os-download-message"

}

Parameter	Description
id	This is a unique identifier returned from Get Devices
os-download-message	Information on the os download (see below)

message	Description
progress	The download progress as a percentage
download successful	Confirm the download is successful and the location it has been stored

Example

curl -X 'GET' \
  'http://localhost:43430/api/v1/devices/00008132-000259C43E99001C/OS/download?version=latest' \
  -H 'accept: application/json'
                                                    

Returns

{
  "result": {
    "id": "00008132-000259C43E99001C",
    "code": 0,
    "message": "Download Successful at the specified location:C:\\ProgramData\\Cambrionix\\DeviceAPI\\firmware\\iOS/iPad_Pro_M4_17.6_21G80_Restore.ipsw"
  }
}
                                                    

Errors

If there is an error in the API method then a will be returned