This API has a deprecated equivalent from v7.0U1.
Create Restore Job
Initiate restore.
Request
URLURL
https://{api_host}/api/appliance/recovery/restore/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"
}
string
location
Required
path or url
location_type
Required
Job.LocationType enumerated type Defines type of all locations for backup/restore
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
a password for a backup piece backupPassword If no password then the piece will not be decrypted
boolean
ignore_warnings
Optional
The flag to ignore warnings during restore If unset, validation warnings will fail the restore operation
string
location_password
Optional
password for location locationPassword Password for the specified user if login is required at this location.
string
location_user
Optional
username for location locationUser User name for this location if login is required.
string
sso_admin_user_name
Optional
Administrators Username for SSO. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
string
sso_admin_user_password
Optional
The password for SSO admin user. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
RecoveryRestoreJobRestoreJobStatus
of type application/json
RestoreJobStatus Structure
{
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"progress": 0,
"state": "FAILED"
}
integer
progress
Required
percentage complete
state
Required
Job.BackupRestoreProcessState enumerated type Defines state of backup/restore process
FAILED : Failed
INPROGRESS : In progress
NONE : Not started
SUCCEEDED : Completed successfully
Possible values are: FAILED , INPROGRESS , NONE , SUCCEEDED
Errors
400
com.vmware.vapi.std.errors.feature_in_use : A backup or restore is already in progress | com.vmware.vapi.std.errors.not_allowed_in_current_state : Restore is allowed only after deployment and before firstboot
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
$RecoveryRestoreJobRestoreRequest = Initialize-RecoveryRestoreJobRestoreRequest -LocationType "FTP" -Location "MyLocation"
Invoke-CreateRecoveryRestoreJob -RecoveryRestoreJobRestoreRequest $RecoveryRestoreJobRestoreRequest
PowerCLI Client SDK All Parameters Example
$RecoveryRestoreJobRestoreRequest = Initialize-RecoveryRestoreJobRestoreRequest -BackupPassword "MyBackupPassword" -LocationType "FTP" -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword" -SsoAdminUserName "MySsoAdminUserName" -SsoAdminUserPassword "MySsoAdminUserPassword" -IgnoreWarnings $false
Invoke-CreateRecoveryRestoreJob -RecoveryRestoreJobRestoreRequest $RecoveryRestoreJobRestoreRequest
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"backup_password":"string","ignore_warnings":false,"location":"string","location_password":"string","location_type":"FTP","location_user":"string","sso_admin_user_name":"string","sso_admin_user_password":"string"}' https://{api_host}/api/appliance/recovery/restore/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/restore/job
x-vmw-doc-operation: create
Availability
Added in 7.0U2
