Get Devices
Get a list of devices with identifiers.
Notes:
Currently only available with Apple devices
Syntax: see Call Structure
Type = 'GET'
|
\'http://localhost:43430/api/v1/devices' \ |
Returns:
|
{ "result": [ { "name": "phone-name", "vendor": { "id": vendor-ID, "name": "device-manufacturer" }, "model": "product-type", "os": { "type": "os-type" }, "trust": { "support": support-pairing, "status": "device-state" }, "identifiers": { "SerialNumber": "usb-serial", "ecid": "ecid", "locationId": "location-id", } } ] } |
| Output | Description |
|---|---|
| phone-name | Name of the phone |
| vendor-id | Device Vendor ID number, VID. Displayed as an Integer |
| device-manufacturer | The name of the device manufacturer |
| product-type | The type and model of the device |
| os-type | The OS type of the device |
| support-pairing | Whether the device supports being trusted/ paired |
| device-state | The status of the device (Normal, Recovery, DFU ... etc) |
| usb-serial | USB serial number |
| ecid | The Exclusive Chip Identifier a special code used to identify the chip inside of your device |
| location-id | The Location IDs as an Integer |
Example
curl -X 'GET' \
'http://localhost:43430/api/v1/devices' \
-H 'accept: application/json'Returns
{
"result": [
{
"name": "iPad",
"status": "connected",
"vendor": {
"id": 1452,
"name": "Apple"
},
"model": "iPad16,3",
"os": {
"type": "iOS"
},
"trust": {
"support": true,
"status": "Normal"
},
"identifiers": {
"SerialNumber": "00008132-000259C43E99001C",
"ecid": "000259C43E99001C",
"locationId": "39303030"
}
}
]
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned