This API has a deprecated equivalent from v7.0U1.
Validate Restore
Get metadata before restore
Request
URLURL
https://{api_host}/api/appliance/recovery/restore?action=validate
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
Restore.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
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
200 OK returns
RecoveryRestoreMetadata of type application/json
Metadata Structure
{
"applicable": false,
"boxname": "string",
"comment": "string",
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"parts": [
"string"
],
"sso_login_required": false,
"timestamp": "string",
"version": "string"
}
boolean
applicable
Required
Does the VCSA match the deployment type, network properties and version of backed up VC
string
boxname
Required
Box name is PNID/ FQDN etc
string
comment
Required
Custom comment
array of
RecoveryRestoreLocalizableMessage
messages
Required
Any messages if the backup is not aplicable
array of
string
parts
Required
List of parts included in the backup.
string
timestamp
Required
Time when this backup was completed.
string
version
Required
VCSA version
boolean
sso_login_required
Optional
Is SSO login required for the vCenter server. This field is optional because it was added in a newer version than its parent node.
Errors
Code SamplesCode Samples
PowerCLI Client SDK Example
$RecoveryRestoreRestoreRequest = Initialize-RecoveryRestoreRestoreRequest -LocationType "FTP" -Location "MyLocation"
Invoke-ValidateRecoveryRestore -RecoveryRestoreRestoreRequest $RecoveryRestoreRestoreRequest
PowerCLI Client SDK All Parameters Example
$RecoveryRestoreRestoreRequest = Initialize-RecoveryRestoreRestoreRequest -BackupPassword "MyBackupPassword" -LocationType "FTP" -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword" -SsoAdminUserName "MySsoAdminUserName" -SsoAdminUserPassword "MySsoAdminUserPassword"
Invoke-ValidateRecoveryRestore -RecoveryRestoreRestoreRequest $RecoveryRestoreRestoreRequest
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"backup_password":"string","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?action=validate
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/validate
x-vmw-doc-operation: validate
Availability
Added in 7.0U2
