It seems like your browser didn't download the required fonts. Please revise your security settings and try again.
Barracuda Intronis Backup
formerly ECHOplatform

Browse Computer API

  • Last updated on

This section provides the output parameters for browsing folders.

Input Parameters

None.

Output Parameters

The output parameters and descriptions are provided in the following table.

Parameter

Description

computerName

String. Used for display purposes only, allows browsing for drives.

windowsVersionString

String. Shows the Windows version string of the computer.

drives

Array. Contains the following structure:

name

String. Root of the drive.

label

String. Drive label (can be empty).

isNtfs

Boolean. Whether the volume is NTFS or not.

isValidScratchDrive

Boolean. Determines if the drive is used as system state backup scratch drive. Not used for files and folders.

selectable

Boolean. Shows whether the drive is selected for back up or not.

unselectableReason

Integer. Shows reason why drive is not selected. If selectable = true, then unselectableReason is 0.  The following values are possible:

  • 0 (none) - means the drive is selectable
  • 1 (LocalVaultPath) - means the drive is not selectable because it contains the local vault, which must not be selected for back up
  • 2 (CompressedOrEncryptedFolder) - means that the drive contains encrypted or compressed folders and cannot be selected directly
  • 3 (UnsupportedFileSystem) - means the drive is not selectable because the file system is not supported

freeSpace

Long. Amount of free space in bytes.

isInLocalBackup

Boolean. Shows whether the drive is already included in a Local Only backup set.

isInCloudBackup

Boolean. Shows whether the drive is already included in a Cloud backup set.

hasChildren

Boolean. Shows whether there are any children (files or folders) underneath the drive.

numberOfFiles

Long. Number of files on the first level of the drive (directly underneath).

numberOfFolders

Long. Number of folders in the first level of the drive (directly underneath).

Example Output

{

    "computerName": "COMP101",

    "drives": [

        {

            "name": "C:\\",

            "label": "OS Volume",

            "isNtfs": true,

            "isValidScratchDrive": false,

            "selectable": true,

            "unselectableReason": 0,

            "freeSpace": 27840376832,

            "isInLocalBackup": false,

            "isInCloudBackup": false,

            "hasChildren": true,

            "numberOfFiles": 11,

            "numberOfFolders": 30

        },

        {

            "name": "E:\\",

            "label": "Documents Volume",

            "isNtfs": true,

            "isValidScratchDrive": true,

            "selectable": true,

            "unselectableReason": 0,

            "freeSpace": 457908015104,

            "isInLocalBackup": false,

            "isInCloudBackup": false,

            "hasChildren": true,

            "numberOfFiles": 27,

            "numberOfFolders": 25

        }

    ],

    "windowsVersionString": "Windows 10 Enterprise"

}