Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Endpoints

Get device information - v1

Returns device information using deviceID.

get/endpoints/v1/devices/{deviceID}

Path parameters

deviceIDinteger required

The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.

Response

OK

deviceIDinteger

The unique id of the device in inSync. Example - 12345

deviceNamestring

The device name in inSync. Example - Ernie Carter's Macbook

serialNumberstring

A unique, identifying number assigned to an individual piece of hardware by the manufacturer. Example - PX045

deviceOSstring

The operating system of the device. Example - Mojave

deviceOSVersionstring

The version of the operating system of the device. Example - 10.14 r34567

platformOS'win32' | 'linux2' | 'darwin' | 'android' | 'ios'

The operating system platform of the device. Example - darwin

uuidstring

A 128-bit number used to uniquely identify device in internet. Example - TY5h67-5674r-675645

clientVersionstring

The inSync Client version installed on the device. Example - 6.1.0 r56746

deviceStatus'enabled' | 'disabled'

The status of the device. Example - enabled

upgradeState'NOT UPGRADABLE' | 'UPGRADABLE' | 'UPTODATE' | 'SCHEDULED' | 'UNKNOWN'

The upgrade state of the device.

userIDinteger

A unique id of the user in inSync.

totalBackupDatastring

The storage quota consumed by the user.

totalBackupDataInBytesinteger

The storage quota consumed by the user (in bytes).

addedOnstring date-time

The date and time on which the device was added to inSync. Example - 2019-10-25T00:00:00Z

lastUpgradedOnstring date-time

The date on which the inSync Client was last updated for the user. Example - 2019-10-25T00:00:00Z

lastConnectedstring date-time

The date and time on which the inSync Client last connected with inSync GovCloud. Example - 2019-10-25T00:00:00Z

deviceMarkedInactiveboolean

Devices marked as inactive. Example - true

Example response

{
  "deviceID": 12345,
  "deviceName": "Ernie Carter's Macbook",
  "serialNumber": "PX045",
  "deviceOS": "mojave",
  "deviceOSVersion": "10.14 r34567",
  "platformOS": "darwin",
  "uuid": "TY5h67-5674r-675645",
  "clientVersion": "6.1.0 r56746",
  "userID": 1,
  "totalBackupData": "40.05 GB",
  "totalBackupDataInBytes": 43003360051,
  "addedOn": "2019-10-25T00:00:00Z",
  "lastUpgradedOn": "2019-10-25T00:00:00Z",
  "lastConnected": "2019-10-25T00:00:00Z",
  "deviceMarkedInactive": true
}