This API has a deprecated equivalent from v7.0U1.
Create Backup Job
Initiate backup.
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/job
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"location": "string",
"location_type": "FTP",
"parts": [
"string"
]
}
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
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: FTP , HTTP , FTPS , HTTPS , SCP , more...
string
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 If unset backup will proceed at slow rate
string
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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
RecoveryBackupJobBackupJobStatus
of type application/json
BackupJobStatus Structure
{
"end_time": "string",
"id": "string",
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"progress": 0,
"start_time": "string",
"state": "FAILED"
}
string
id
Required
TimeStamp based ID.
integer
progress
Required
Progress of the job in percentage.
string
start_time
Required
Time when the backup was started.
state
Required
The Job.BackupRestoreProcessState enumerated type defines the possible states of a backup/restore process.
FAILED : Backup/Restore job failed.
INPROGRESS : Backup/Restore job is in progress.
NONE : Backup/Restore job is not started.
SUCCEEDED : Backup/Restore job completed successfully.
Possible values are: FAILED , INPROGRESS , NONE , SUCCEEDED
string
end_time
Optional
Time when the backup was finished. If unset end time is None until backup is finished.
Errors
500
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$RecoveryBackupJobBackupRequest = Initialize-RecoveryBackupJobBackupRequest -Parts "MyParts" -LocationType "FTP" -Location "MyLocation"
Invoke-CreateRecoveryBackupJob -RecoveryBackupJobBackupRequest $RecoveryBackupJobBackupRequest
PowerCLI Client SDK All Parameters Example
$RecoveryBackupJobBackupRequest = Initialize-RecoveryBackupJobBackupRequest -Parts "MyParts" -BackupPassword "MyBackupPassword" -LocationType "FTP" -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword" -Comment "MyComment" -FastBackup $false
Invoke-CreateRecoveryBackupJob -RecoveryBackupJobBackupRequest $RecoveryBackupJobBackupRequest
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"backup_password":"string","comment":"string","fast_backup":false,"location":"string","location_password":"string","location_type":"FTP","location_user":"string","parts":["string"]}' https://{api_host}/api/appliance/recovery/backup/job
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/recovery/backup/job
x-vmw-doc-operation: create
Availability
Added in 7.0U2
