1. Documentation
  2. CrashPlan
  3. App administration
  4. App reference

CrashPlan app reference

Updated

This article applies to all products.png

Overview

The CrashPlan app allows you to back up your device, change backup settings, and download backed up files from all the devices on your account. This guide provides a description of settings and features in the CrashPlan app.

Home

From the upper-left corner of the CrashPlan app, click Home to open default view of the app.

client reference home page.png

Item Description
a Device name Name of your current device. Device name can be changed from Device preferences > General.
b Device details menu Options for this device.
c Downloads Opens a queue of active, pending, and complete downloads in the CrashPlan app.
d Settings Opens device preferences.
e

Pause Backups

Pauses backups for 1 hour. This option is unavailable if an administrator has disabled it with the Pausing Controls setting. 
f

Restore Files

Opens a file browser for viewing and downloading files that are backed up for this device. If you have more than one device, clicking the button displays a list of devices to choose from. The button is hidden if you do not have permission to access your backed-up files.
g Backup set name

Name of the backup set. By default, backup set name is based on your device name.

  • Backup sets must have a name.
  • Backup sets for a particular device must have unique names. The CrashPlan app updates the name of a backup set if the name you entered is already in use.
  • Backup sets for the device appear in the order defined by backup set priority. Priority can be configured from Backup Set Settings.
h Backup set size

Size of the backup file selection for the backup set.

  • The size shown can fluctuate if the file verification scan is running.
  • The size shown may not equal the size of the backup set's archive as a result of compression, de-duplication, and version retention.
i Manage Files Opens file browser for viewing and updating the files and folders on this device included in a particular backup set.
j Backup set settings button Opens a view that allows you to view and manage settings for the backup set.
k Backup destination status icon

Status of backup to this destination:

 Backing up but the percent complete cannot be estimated.

Backing up and a percent complete can be estimated.

Backing up according to your backup schedule and frequency settings. There may or may not be files in the list of files to back up.

Backup has not started because the backup set is missing files or folders in your backup file selection, missing a destination, or both. Backup does not start without completing setup.

Backup is not running. The CrashPlan app may be scanning the file selection, connecting to the destination, or preparing backup.

Paused or unable to back up. If backup is not paused, this means that the time since the CrashPlan app's last backup is greater than than the setting for backup frequency, but less than your alert setting. Backup may resume without intervention.

Unable to back up and requires intervention to resume backing up.
l Backup destination name The name of backup destinations in use for the backup set.
m Backup destination status message Detailed status information about the backup destination.
n Run backup now Starts backup on a destination that is waiting for its next scheduled backup. Once initiated, backup continues until it's complete, even if it extends beyond the scheduled end time. This option is unavailable outside of your backup schedule. 

Restore files

Click Restore Files to browse, search, and download files backed up for a device.

restore files reference.png

Item Description
a Device Name

Name of the device where the files shown originated, sometimes referred to as the source device.
b Destination

Destination where the files shown were backed up. If you back up to multiple destinations, select the destination from which to restore files.
c Search

Opens a search view for locating files and folders by keyword or phrase.

  • Clicking a folder within your search toggles between viewing search results and browsing within folders. Files selected for download remain selected when toggling between search and browse.

  • The CrashPlan app searches your backup using current selections for Destination, As of Date, Include deleted files, and Show hidden files. You can refine search results using the options for As of Date, Include Deleted Files, and Show Hidden Files.

  • Your search term is retained until you clear the term, close the search bar, or exit the view. Click the search icon to return to your search results for that term.

  • Results are limited to 10,000 files or folders.
d As of Date

Opens a calendar for filtering files and versions by a particular date.

  • By default, the calendar is set to the current date and time.
  • Click Most Current to automatically set date and time to the current date and time.
e Options menu Opens the options menu for including deleted files and showing hidden files in the file browser.
f Breadcrumb overflow menu Opens a menu listing folders in your backup that precede the folders currently displayed in the breadcrumb. Click a folder name to navigate to that folder.
g Breadcrumb Displays the current folder or file and up to two folders leading to it. Click a folder name in the breadcrumb to navigate to that folder. The breadcrumb tracks the folder hierarchy within your backup.
h Name File or folder name of a backed up file. Click to sort by name.
i Size Size, in bytes, of backed files.
j Date Modified Date that the file or folder was last modified on the file system.
k Previous version selected Indicates that a previous version of the file is currently selected for download.
l Download

Displays when you mouse over a file. On click, immediately downloads:

  • From the currently-selected destination
  • The most recent version of the file, even if an earlier version was previously selected
  • With the default options for download location, existing files, and permissions
m Versions Displays when you mouse over a file. On click, opens a view including all backed up versions of the file.
n Selected file or folder

Indicates that a file or folder is selected for download:

 A file, or a folder and all of its subfolders, is currently selected.

 One or more subfolders within the folder is currently selected.
o Deleted file Indicates a file deleted from the file system. From the options menu, Include deleted files must be enabled before deleted files display in the file browser.
p Count of files selected Displays a count and size for files currently selected for download.
q Done Exits the view.
r

Restore Files

 Opens download options for selected files. The button is dimmed until at least one file or folder is selected for download.

Restore files options menu

From Restore Files, click the options menu () to display more options for viewing and downloading backed up files.

Command Description
Include deleted files

Displays or hides deleted files. When enabled, downloaded folders include any deleted files in that folder.
Show hidden files Displays or hides hidden temporary and system files. Hidden files are always included in downloaded folders, regardless of whether the setting to view them is enabled.

File versions

From Restore Files, mouse over a file and click the versions icon () to see all versions backed up for that file. To exit file versions, use the breadcrumb to navigate back to all files.
restore files versions reference.png

Item Description
a File name Name of the file for the versions shown. Click the preceding file name to exit the file versions view.
b Date Modified Date and time that a file version was modified on the device's file system.
c Size Size, in bytes, of file version backed up.
d Last Backed Up Date and time that the file version was backed up.
e Current Displays the latest version of the file.
The current version may not be the same as the most recently backed up and modified version. This occurs when an earlier version is downloaded to the original location and overwrites the existing file. The restored version has an earlier Date Modified and Last Backed Up date than other versions, but it is now the most "current" version on the device's file system.
f Selected Version selected for download. You can only download a single version at a time.
g

Deleted

Version of the file that has been deleted. You cannot restore a deleted version of a file. You can restore a different version that has not been deleted. You can also restore a deleted file from the Restore Files screen using the Options menu. 
h Done Exits the view.
i Restore Files Opens download options for the selected files. The button is dimmed until at least one file or folder is selected for download.

Restore files options

To open options for downloading selected files, click Restore Files from the Restore Files view.  

restore files options reference.png

Item Description
a Save selected files to

Sets the download location for the selected files.

  • By default, set to your device's Downloads folder.
  • Includes options for the following locations: Downloads folder, Desktop, Original Location, Other (for selecting a custom location).
b If file already exists

Specifies whether you want existing files (files that are on your device right now) renamed or overwritten when a file matching the file name downloads to the same location.

  • By default, set to rename existing files.
  • If set to rename existing files, the CrashPlan app adds the prefix "original1" to the existing files.
c Permissions

Specifies ownership of restored files. By default, it is set to Current.

To change permissions, you must have write permissions to the files. Two settings are available:

  • Current: (Best practice) When the file is restored, its ownership is changed to be the user doing the restore.
  • Original: When the file is restored, it retains the ownership that the user had on the file when it was backed up. 
d Cancel Exits the options view and returns to the file browser.
e Go Adds selected files to Downloads using the selected settings. If settings were modified, your changes are maintained until you exit the Restore Files view or you close the CrashPlan app.

Downloads

From the upper-right corner of the CrashPlan app, click Downloads to open Download Activity.

Download Activity Reference.png

Item Description
a Clear all Removes completed downloads from the list of Download Activity.
b Queued Files queued for download display. Files are downloaded in the order that they are added to the queue.
c Download status Total bytes completed and remaining for an active download.
d Pause/resume download Pauses or resumes an active download.
e Show folder

On mouse-over, displays the option to open the location where files are downloaded.

  • If files are downloaded to original location and the original location includes multiple folders, this option is not available.
  • If the location is no longer on your file system, your file browser does not open.
f Clear On mouse over, displays the option to remove a completed, in process, or pending download from the list of Download Activity.

Manage files

From Home, click Manage Files for a backup set to view the file selection for the selected set. If your administrator prevents editing of the file selection, you can browse, but not modify, your file selection.

Manage Files Reference.png

Item   Description
a Backup set name Name of the backup set for the file selection shown.
b Options menu Opens the options menu for showing hidden files in the file browser.
c Breadcrumb overflow menu Opens a menu listing folders on your file system that precede the folders currently displayed in the breadcrumb. Click a folder name to navigate to that folder.
d Breadcrumb Displays the current folder and up to two additional folders leading to it in your backup file selection. The breadcrumb tracks the folder hierarchy within your file selection. Click a folder name in the breadcrumb to navigate to that folder.
e Name File or folder name on your device's file system. Click to sort by name.
f Size Size, in bytes, of the file on your device's file system. Click to sort by size.
g Date Modified Date that the file or folder was last modified on the file system. Click to sort by date modified.
h Selected

Indicates that a file or folder is selected for backup:

 A file, or a folder and all of its subfolders, is currently selected. New folders and files added to these folders are also added to your backup file selection.

 One or more subfolders within the folder is currently selected. New subfolders and files added to these folders are not added to your backup file selection.
i File icon

Indicates more information about a particular file or folder:

File is excluded from backing up to cloud destinations, but it can be backed up to local destinations.

File is excluded from backing up to cloud and local destinations.

File or folder was previously selected, but it cannot be found on the file system. Missing files are most commonly the result of disconnected external drives.
j Cancel Discards any changes to the file selection and exits the Manage Files view.
k Save

Saves changes to the file selection. CrashPlan prompts you to confirm changes that delete files and folders from your backup archive.

Manage files options menu

From Manage Files, click the options menu () to display more options for viewing files in your file selection.

Command Description
Show hidden files Displays or hides hidden temporary and system files. Hidden files are always backed up, regardless of whether or not the setting to view them is enabled.

 

Device preferences

To access device preferences, click Settings from Home.

Many settings in Device Preferences can be configured and locked by your administrator. If a setting is locked, then it is not displayed in the CrashPlan app. If all the settings on a tab are locked, the tab is not displayed in the CrashPlan app.

General

From Device Preferences, click General to view and manage settings for your device.

device preferences updated.png

Item   Description
a Device Name The name of this device in your CrashPlan environment. By default, Device Name uses the Hostname reported by the device's operating system, but you can change the device name by clicking Rename.
b Rename Renames the device that you are currently using. Your device must have a name.
c Device ID Identification number assigned by the CrashPlan app to this device. The CrashPlan app uses a unique sequence of numbers to distinguish one device from another and to facilitate the backup and download processes.
d Hostname

The name of the device as reported by the device's operating system. The Hostname is a device property that is not managed by CrashPlan. If an authorized user changes the hostname of the device, the CrashPlan app may not reflect the new hostname right away.
e Language

Sets the language in which the CrashPlan app displays.

Automatic - CrashPlan displays the default language specified by your operating system.

When you change the language, the CrashPlan app starts logging history in the new language. Therefore, the history log might contain entries in multiple languages.
f

Show CrashPlan status in menu bar
Mac only

 Indicates backup in progress in the menu bar.
-

Display CrashPlan icon in notification area
Windows only

 Displays the icon in the notification area.
g Open CrashPlan in menu bar on login
Mac only 		Launches the menu bar app when you log in to your device.
- Display CrashPlan icon in notification area on login
Windows only 		Displays the icon in the notification area when you log in to your device.
h Manage account on the web Opens your default web browser to the CrashPlan console, where you can manage your account online.

Usage

From Device Preferences, click Usage to view and manage settings for your device.

app-ref-usage.png

Item   Description
a Alert me if this device is not backed up for Sets the number of consecutive days of not backing up before a destination displays an alert in the CrashPlan app. Your administrator may also configure email alerts to be sent after the period specified.
b Remind me again if this device still is not backed up after Sets the number of days after the initial alert that an email may be sent to notify you that the CrashPlan app is not backing up. Your administrator may disable email alerts.
c

User is away when not active for

 Sets the number of minutes of inactivity before you are considered “away” from the device.
d

When user is away, limit performance to:

 

 

(Windows and Mac only)

Sets the amount of system resources that the CrashPlan app may use when you are away from the device. The performance limit cannot be lower than 10%.

For more information, see Configure app performance in the CrashPlan console.

The CrashPlan app relies on mouse and keyboard activity to detect if you are using your device. It may take up to 30 seconds to detect a change in status.

e

 When user is present, limit performance to:

Sets the percent of system resources that the CrashPlan app may use when you are using the device. The performance limit cannot be lower than 10%.
f

Stop backup when battery reaches

 

(Windows and Mac only)

 Sets the percent of remaining battery power at which backup automatically pauses to conserve power on laptop devices.
g Perform shallow maintenance every Indicates how often shallow maintenance runs for local archives, which checks the health of the archive, and prunes versions and deleted files. This scan completes faster than the deeper maintenance. Maintenance of cloud destinations is configured by your administrator.
h Perform deep maintenance every Indicates how often deep maintenance runs for local archives, which uses checksum of all data blocks to verify health of archive. This scan automatically occurs on each block silo that is able to reclaim space.

Destinations

From Device Preferences, click Destinations to view and manage settings for your device.

client reference destinations settings.png

Item Description
a Cloud Cloud destinations that backup sets on this device are able to back up to.
b Local Local destinations that backup sets on this device are able to back up to.
c Destination name The name of the destination shown.
d Space used Amount of space this device's archive is storing on the destination shown.
e Run maintenance Reclaims space in the backup archive by immediately applying file selection or retention policy changes (such as how many versions to keep and how long to keep deleted files).
f Quota Amount of space allocated for your backup archive on this destination. Your administrator may configure a space limit. Automatic means that there are no space restrictions.
g Add destination Opens a file browser for adding a local destination, such as an external drive or folder.
h Delete destination Stops backup to a local destination and deletes all the archives stored on it. The destination is no longer available to backup sets. Deleting a destination cannot be undone.
i Delete Archive

Deletes the archives for this device on the destination shown.

  • The destination is still available for adding to backup sets, but backup must start over. Deleting an archive cannot be undone.
  • Option only displays when there is an archive stored on the destination.

Network

From Device Preferences, click Network to view and manage settings for your device.

client reference network settings.png

Item Description  
a Bandwidth WAN

Bandwidth limit to destinations external to your local network when you are using (present) and not using (away from) your device.

Windows only:

The CrashPlan app relies on mouse and keyboard activity to detect if you are using your device. It may take up to 30 seconds to detect a change in status.
b Bandwidth LAN

Bandwidth limit to destinations on your local network when you are using (present) and not using (away from) your device.

Minimum sending limits
When setting network sending limits, do not set a rate lower than 0.10 Mbps or 100 Kbps. Rates lower than 0.10 Mbps can prevent devices from communicating with the CrashPlan cloud, which can stop backups and future configuration changes. To stop backup entirely, do not adjust sending limits. Instead, you can only allow backups at specified times.

Windows only:

The CrashPlan app relies on mouse and keyboard activity to detect if you are using your device. It may take up to 30 seconds to detect a change in status.
d Network interface exclusions

Windows and Mac only 		Disables backup when your device is connected to an excluded network interface. Unless a network interface is explicitly excluded, backup is allowed over any connected network interface. A network interface must be connected before it can be disabled; however, once an interface is disabled, it remains disabled in the CrashPlan app unless specifically re-enabled.
– Proxy Configures proxy settings to allow the CrashPlan app to connect to the Internet via a proxy server.
– Server Address

Primary and secondary network address for your CrashPlan server.

Your administrator may prevent you from seeing or editing the Server Address.

Ports

The CrashPlan app requires the following ports to communicate with your backup destinations.

Port(s) Protocol Destination Description
4244* TCP localhost (Default) Used by the CrashPlan app to connect to the CrashPlan service.
443 TCP CrashPlan cloud (Required) Used by the CrashPlan app to connect to the CrashPlan cloud.

* Depending on your configuration, alternative ports may be used.

Security

From Device Preferences, click Security to view and manage settings for your account.

device preferences security.png

Item Description
a Require account password to open the CrashPlan app

Indicates whether you must sign in using your account password when launching the CrashPlan app.

Require password for added security
You should require the account password to open the CrashPlan app. If the device is lost, stolen, or infected with malware or ransomware, this helps protect backed-up files from being accessed or deleted by an unauthorized user.
b Account Encryption Key Security

Opens a prompt to upgrade or change your account encryption key security setting.
c

Account Encryption Key Security Level

Indicates the level of security used to protect the encryption key for your devices. This setting applies to all of the devices on your account.

  • Account password
  • Archive key password
  • Custom key

Account encryption key security

From Account Encryption Key Security, select Upgrade to see options for creating an archive key password or custom key.

client reference security encryption.png

Item Description
a Account Password

Selects the default encryption key security setting. You or your administrator can restore files without providing an additional password.
b Archive Key Password

Displays options for creating an archive key password:

  • Upgrade your account security setting to use an archive key password.
  • Create a recovery question and answer.
  • Change your archive key password or recovery question.

When enabled, you or your administrator can restore files only by providing the correct archive key password.

If you choose this option, you will not be able to downgrade your security.
c Custom Key

Displays options for creating a custom key:

  • Import: Opens a file browser to import a custom key.
  • Paste from clipboard: Enters plain text from your clipboard.
  • Passphrase: Opens a prompt to generate an encryption key from a passphrase.
  • Generate key: Displays options for generating a custom key.

When enabled, you or your administrator can restore files only by providing the custom key. The custom key cannot be reset if it is forgotten or lost. Without the custom key, backup data is unrecoverable.

If you choose this option, you will not be able to downgrade your security.

Backup Sets

From Device Preferences, click Backup Sets to view and change settings for the backup set. 

You can also access these settings by clicking the Backup set settings button from Home.

backup sets reference.png

Item Description  
a Backup set name

Name of the backup set. By default, the backup set name is based on your device name.

  • Backup sets must have a name.
  • Backup sets for a device must have unique names. If you enter a name that is already in use, the CrashPlan app updates the new backup set's name.
b Backup Set Settings menu Opens the Backup Set Settings menu.
c Backup Schedule

Sets the times when the CrashPlan app can back up files.

  • Backup schedule defines when the CrashPlan app can run, whereas backup frequency defines how often the CrashPlan app backs up new and updated files.
  • Administrators can set, and may prevent editing of, this setting.
d File Exclusions

Excludes files from backing up based on file name, extension, or regular expression.

  • Excluding files previously selected for backup marks the excluded files for deletion from the backup archive. Excluded files are purged from the backup archive during the next scheduled archive maintenance.
  • Administrators can set, and may prevent editing, of this setting.
Shared destinations
If multiple backup sets share a destination, then file exclusions specified for any backup set impact all sets backing up to that destination.
e Destinations

Sets the locations where backup data is sent and stored.

  • At least one destination is required.
  • If enabled by your administrator, allows creation of local destinations (for example, external drives).
  • Administrators can set, and may prevent editing, of this setting.
f Priority Sets the order in which the selected backup set runs for this device.

Backup Set Settings menu

To view the Backup Set Settings menu, click the  button from the Backup Sets view.

Command Description
Manage Files Displays files in the backup set in the Manage Files view.
Scan for file changes Scans your backup selection for file changes and deleted files.
Delete

Deletes the backup set and all its backup archives on all destinations.

  • Displays only when the device contains more than one backup set.
  • Default backup set cannot be deleted.
  • Administrators may disable the ability to delete backup sets.

Backup Schedule

From the Backup Sets view, click Change in the Backup Schedule row.

backup schedule reference.png

Item Description
a Schedule selector
  • Always keep up to date: The CrashPlan app will back up your files as long as the device is on and not in sleep mode (default installation type), or on and user is signed into the device (per-user installation type). 
  • Only run between specified times: The app will back up your files during the days and times specified below.
    • When set to run between specified times, the CrashPlan app uses the time provided by your device's operating system.
    • If the To time is earlier than the From time for a particular day, then backup can run until that time on the next day, even if that day is not selected.
b Times of day Set the times of day to back up.
c Days of the week Select the days of the week to back up.  
d Cancel Discard any changes and exit the Backup Schedule view.
e Save Save changes and exit the Backup Schedule view.

 

 

File Exclusions

From the Backup Sets view, click Change in the File Exclusions row.

file exclusions reference.png

Item Description
a Exclude files ending with Enter a file extension to exclude from the backup set.
b Use regular expression Option to use a regular expressions instead of a literal file extension.
c Exclusions File types that are excluded from the backup set. 
d Add Click to add the entered extension to the list of exclusions.
e Cancel Discard any changes and exit the File Exclusions view.
f Save Save changes and exit the File Exclusions view.

Destinations

From  the Backup Sets view, click Change in the Destinations row.

add destination reference.png

Item Description
a Destinations Select the destinations to back up to.
b Add Local Destination Add an external hard drive to back up to. 
c Cancel Discard any changes and exit the Destinations view.
d Save Save changes and exit the Destinations view.

Priority

From  the Backup Sets view, click Change in the Priority row.

backup set priority reference.png

Item Description
a Adjust priority

The top priority backup set will finish backing up first, followed by the second set, and so on.  

If a set backs up to multiple destinations, the CrashPlan app completes the backup to a single destination before backing up to additional destinations.
b Cancel Discard any changes and exit the Priority view.
c Save Save changes and exit the Priority view.

Add backup set

From the device details menu, select Add Backup Set to create a new backup set for the current device.

add backup set reference.png

Item Description
a Backup set name Name for the new backup set. By default, the CrashPlan app assigns a name using your device name.
b Rename Renames the backup set you are creating. Your backup set must have a name.
c File Selection Opens Manage Files for adding files and folders on this device to the new backup set. You must select at least one file to add a backup set.
d Destinations

Sets the locations where backup data is sent and stored for this backup set.

  • At least one destination is required to add a backup set.
  • If enabled by your administrator, allows creation of local destinations (for example, external drives).
e Cancel Discards changes and returns you to Details.
f Add Set Adds a new backup set using the settings selected. You must select a name, file selection, and destination before a backup set can be added.

History

History provides a log of your backups and shows the CrashPlan app's current activity. Open History from your menu bar:

  • Windows:  Tools > History
  • Mac:  Window > History

client history reference.png

Item Description
a Date Date and time of backup activity.
b Message Description of backup activity.
c Backup set name Name of the backup set that corresponds to the activity described in the message.
Was this article helpful?
0 out of 1 found this helpful

Articles in this section