Developer Documentation

JobBackupRequest

The Job.BackupRequest structure represents a requested backup piece.


Properties

Required Property Name Type Description
optional backup_password string

Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). backupPassword If no password then the piece will not be encrypted

optional comment string

Custom comment provided by the user. If unset comment will be empty.

required location string

Path or URL of the backup location.

optional location_password string

Password for the given location. If unset authentication will not be used for the specified location.

required location_type JobLocationType Enum

Type of backup location.

optional location_user string

Username for the given location. If unset authentication will not be used for the specified location.

required parts array of string

List of optional parts that will be included in the backup. Use the Parts.list operation to get information about the supported parts.

Feedback

Was this page helpful?