v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Endpoints

List all devices - v1

Returns information about all the user devices protected using Druva inSync.

get/endpoints/v1/devices

Query parameters

userIDinteger

Specify the user ID to get a list of devices associated with a single user. Get the ID of a user using the 'List all users' API.

userIDsinteger[]

Specify the user IDs, separated by commas, to get a list of devices associated with multiple users. Get the user IDs using the 'List all users' API.

deviceIDsinteger[]

Filter the list of devices by specifying only the required device IDs, separated by commas. Get the device IDs by using this ‘List all devices’ API.

profileIDsinteger[]

Specify the profile IDs, separated by commas, to get a list of devices associated with multiple profiles. Get the ID of a profile using the ‘List all profiles’ API.

searchPrefixDeviceNamestring

Specify the prefix from the device name by which you intend to search and list the devices. Example - “My” is the prefix in the device name “MyDevice123”.

clientVersionstring

Filter the list of devices by the inSync Client version installed on it. Example - 6.2.0

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

Filter the list of devices by specifying the operating system of the device.

deviceStatus'enabled' | 'disabled'

Filter the list by specifying the status of the device.

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

The upgrade state of the device.

pageTokenstring

The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.

minLastConnectedstring date-time

Filter to list devices that are connected to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ

maxLastConnectedstring date-time

Filter to list devices that are connected to Druva inSync before a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ

minAddedOnstring date-time

Filter to list devices that are added to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ

maxAddedOnstring date-time

Filter to list devices that are added to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ

serialNumberstring

Get device information using the unique serial number assigned to an individual piece of hardware by the manufacturer.

uuidstring

Get device information using the unique 128-bit number UUID used to identify device on internet.

deviceMarkedInactiveboolean

Filter the list of devices that are marked as inactive. For example, if you select true, all devices that are marked as inactive are listed. For more information about inactive devices, see <a href=https://docs.druva.com/Endpoints/030_Set_up_inSync_for_Endpoints/010_Initial_Configuration/030_Create_and_manage_profiles/010_Create_a_profile>Create Profile</a>.

Response

totalSizeinteger

The total number of devices listed in the result pages.

nextPageTokenstring

The token to access next page of results. This parameter will be empty for the last page of results.

Example response

{
  "totalSize": 1,
  "nextPageToken": "MTExMQ==",
  "devices": [
    {
      "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
    }
  ]
}