The Code42 API
DeviceBackupReport resource efficiently retrieves the data you need to address common problems and answer common questions about users and devices in your Code42 environment.
DeviceBackupReport provides centralized reporting and better performance than separate calls to the
Capabilities of the DeviceBackupReport resource
DeviceBackupReport provides information about users and devices in your Code42 environment, such as:
In very large Code42 environments (100,000+ devices), sending a request to the
DeviceBackupReportresource without specifying at least one parameter-value pair puts an unusually heavy load on the Code42 server and can cause noticeable performance delays. Code42 recommends specifying query parameters and values whenever possible.
Before you begin
Before you attempt to use
DeviceBackupReport, become familiar with the basics.
- Query parameters
- Output values
- Example usage
Partial string match and flexible search
You can search for users, organizations, devices, destinations, and operating systems using partial string matching. The search is conducted against multiple source fields for each entity. For example, you can search for a user based on the user's last name, username, email, or the
For a complete explanation of which fields are used by flexible searches, see the DeviceBackupReport entry in the Code42 API Documentation Viewer.
- All records are returned when exporting to CSV format.
- Paging is not used when exporting in CSV format, even if the
pgSizequery parameter is specified.
- CSV format is ideal when the
DeviceBackupReportresource does not provide the sorting, grouping or filtering you require. Simply open the CSV file in your spreadsheet, and apply the sorting and grouping options you require.
Sort and page
When sorting using the
srtKey query parameter, paging is limited to the first page.
Example use cases
The following examples show how to use
DeviceBackupReport to administrate your Code42 environment.
Use case 1: Backup status report
This backup status report identifies which devices have not backed up for a long period of time.
This request shows device backup status for active devices, sorted by the time they last connected to a Code42 server:
Interpret the results
The default sorting direction is ascending, so the first devices listed are the devices that have not connected for the longest period of time. The
backupCompletePercentage data can help you identify whether some or all data on a device has successfully backed up.
Using this information, you can investigate user devices that have not connected for a long time. Some possible causes:
- The user is on vacation or sabbatical.
- A remote user's router or firewall is preventing connection.
- The Code42 service has been disabled on the device.
- The user uninstalled the CrashPlan app.
Use case 2: Disk usage
This disk usage report identifies the users who are consuming the most storage space.
This request shows devices sorted by the size of their archives:
Interpret the results
The devices with the largest archives are listed first, highlighting the users and devices that are taking up the most disk space in your Code42 environment. You can then examine the file exclusions, version settings, and other device backup settings for these users, and make changes that can reduce archive sizes.
Alternatively, you may want to sort the output by the total size of the files and folders selected for backup, rather than by the size of the archives stored by the Code42 environment:
Use case 3: Device migration planning
DeviceBackupReport can identify devices running a particular operating system in an organization, and how much data will need to be migrated to replacement devices.
This request shows all OS X devices in the organization named "Accounting:"
Replace the operating system type and organization name in this example request with values appropriate for your Code42 environment.
Interpret the results
The OS X devices with the largest archives are listed first, highlighting the migrations that may take longer.
Use case 4: Purge cold storage to free space
To locate archives that can be purged from cold storage,
DeviceBackupReport shows all devices with archives in cold storage, along with the date on which the devices last connected.
This is an example only. Before purging any archives from cold storage, confirm that the archives are no longer needed. Depending on your company's data retention policy, archives may need to be kept for a defined period of time.
The following request generates a CSV file with backup information for all devices:
Interpret the results
In this example, the data is available for download through your web browser. After downloading the file, open the file in a spreadsheet, and sort the results by the output value
coldStorage output value has the boolean data type.
- True indicates that a device's archive is in cold storage.
- False indicates that a device's archive is not in cold storage.
The report contains a list of all the devices in the Code42 environment. By filtering the results to show only devices with archives in cold storage, and sorting this filtered list by the last connected date, the administrator can confirm that the archives are no longer needed and purge the archives to free up space.
Use case 5: Search based on custom metadata fields
DeviceBackupReport also searches reference fields, which are used to store descriptive information for users (
userExtRef), devices (
deviceExtRef) and organizations (
The user query parameter flexibly searches on username, email,
userExtRef, or last name. The following request finds all devices for a user based on
userExtRef, such as an employee ID number stored in the reference field:
Security and permissions
DeviceBackupReport resource cannot make changes to your Code42 environment, so it is safer to use than other resources that provide the same data.
Roles and permissions
DeviceBackupReport resource can be used by any user in your Code42 environment, but the results that it can provide are limited by the the permissions that are assigned to the user's role. For example:
- A standard desktop user with no additional permissions can get information on her own devices, but cannot get information on anyone else's devices.
- An org manager can get information on all the devices of the organization that he manages, but not for devices in other organizations.
- A system administrator can get information on any user in the Code42 environment.
You can create a custom role with the specific permissions needed, if necessary.