RecoveryBackupJobBackupRequest

The Job.BackupRequest structure represents a requested backup piece.


Properties

string as password
backup_password Optional

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


string
comment Optional

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


string
location Required

Path or URL of the backup location.


string as password
location_password Optional

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


location_type Required

The Job.LocationType enumerated type defines the type of destination location for backup/restore. You specify the location type when you create a backup job. See Job.BackupRequest.
FTP : Destination is FTP server.
HTTP : Destination is HTTP server.
FTPS : Destination is FTPS server.
HTTPS : Destination is HTTPS server.
SCP : Destination is SSH server.
SFTP : Destination is SFTP server.
NFS : Destination is NFS server.
SMB : Destination is SMB server.

Possible values are: FTPHTTPFTPSHTTPSSCPSFTPNFSSMB


string
location_user Optional

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


array of string
parts Required

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

JSON Example

{
	"location": "string",
	"location_type": "FTP",
	"parts": [
		"string"
	]
}

Feedback

Was this page helpful?