This API has a deprecated equivalent from v7.0U1.
Validate Backup
Check for backup errors without starting backup.
Request
URLURL
https://{api_host}/api/appliance/recovery/backup?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",
"parts": [
"string"
]
}
array of
string
parts
Required
a list of optional parts. Run backup parts APIs to get list of optional parts and description
string
location
Required
path or url
location_type
Required
Backup.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 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 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
comment
Optional
Custom comment comment an optional comment
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryBackupReturnResult
of type application/json
ReturnResult Structure
{
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"status": "FAIL"
}
status
Required
Backup.ReturnStatus enumerated type Defines the state of precheck
FAIL : Check failed
WARNING : Passed with warnings
OK : Check passed
Possible values are: FAIL , WARNING , OK
Errors
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
$RecoveryBackupBackupRequest = Initialize-RecoveryBackupBackupRequest -Parts "MyParts" -LocationType "FTP" -Location "MyLocation"
Invoke-ValidateRecoveryBackup -RecoveryBackupBackupRequest $RecoveryBackupBackupRequest
PowerCLI Client SDK All Parameters Example
$RecoveryBackupBackupRequest = Initialize-RecoveryBackupBackupRequest -Parts "MyParts" -BackupPassword "MyBackupPassword" -LocationType "FTP" -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword" -Comment "MyComment" -FastBackup $false
Invoke-ValidateRecoveryBackup -RecoveryBackupBackupRequest $RecoveryBackupBackupRequest
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?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/backup/validate
x-vmw-doc-operation: validate
Availability
Added in 7.0U2
