RecoveryBackupJobBackupRequest

The Job.BackupRequest structure represents a requested backup piece.


Properties

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.


string
location Required

Path or URL of the backup location.


location_type Required

Type of backup location.

Possible values are: FTPHTTPFTPSHTTPSSCPSFTPNFSSMB


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


boolean
fast_backup Optional

Option to enable Postgres DB/ VCDB fast backup Setting this true might have performace impact If unset backup will proceed at slow rate


string as password
location_password Optional

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


string
location_user Optional

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


string
comment Optional

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

JSON Example

{
    "location": "string",
    "location_type": "enum",
    "parts": [
        "string"
    ]
}
Parameter To

Create Backup Job
Feedback

Was this page helpful?