Appliance Recovery Backup validate
Check for backup errors without starting backup.
BackupRequest Structure
Show optional properties
{
"parts": [
{}
],
"location_type": "string",
"location": "string"
}{
"parts": [
"string"
],
"backup_password": "string",
"location_type": "string",
"location": "string",
"location_user": "string",
"location_password": "string",
"comment": "string",
"fast_backup": false
}a list of optional parts. Run backup parts APIs to get list of optional parts and description
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
a type of location
For more information see: Appliance Recovery Backup LocationType.
path or url
username for location
locationUser User name for this location if login is required.
password for location
locationPassword Password for the specified user if login is required at this location.
Custom comment
comment an optional comment
Option to enable Postgres DB/ VCDB fast backup.
If missing or null backup will proceed at slow rate
ReturnResult Structure
"Appliance Recovery Backup ReturnResult Object"Check status
For more information see: Appliance Recovery Backup ReturnStatus.
List of messages
A backup or restore is already in progress
"Vapi Std Errors FeatureInUse Object"Generic error
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"location:"string","location_type:"string","parts":["string"]}' https://{api_host}/api/appliance/recovery/backup?action=validate