Validate Restore
Get metadata before restore
Request
URLURL
Header Parameters
Header Parameters
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
{
"location": "string",
"location_type": "FTP"
}
path or url
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...
a password for a backup piece backupPassword If no password then the piece will not be decrypted
password for location locationPassword Password for the specified user if login is required at this location.
username for location locationUser User name for this location if login is required.
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.
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
Response
Response BodyResponse Body
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"
}
Does the VCSA match the deployment type, network properties and version of backed up VC
Box name is PNID/ FQDN etc
Custom comment
Any messages if the backup is not aplicable
List of parts included in the backup.
Time when this backup was completed.
VCSA version
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
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
PowerCLI Client SDK All Parameters Example
cURL Command
Vendor Extensions
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/recovery/restore/validate
x-vmw-doc-operation: validate