Appliance Recovery Restore validate

Appliance Recovery Restore validate

Get metadata before restore

Request
URI
POST
https://{api_host}/api/appliance/recovery/restore?action=validate
COPY
Request Body

RestoreRequest Structure

Appliance Recovery Restore RestoreRequest of type(s) application/json
Required

Show optional properties

{
    "location_type": "string",
    "location": "string"
}
{
    "parts": [
        "string"
    ],
    "backup_password": "string",
    "location_type": "string",
    "location": "string",
    "location_user": "string",
    "location_password": "string",
    "sso_admin_user_name": "string",
    "sso_admin_user_password": "string"
}
array of string
parts
Optional

List of standalone parts to restore. Only parts with the Appliance Recovery Backup Parts Part.standalone flag set to true can be included.

This property was added in vSphere API 8.0.3.0.

If missing or null entire VCSA will be restored.

string As password As password
backup_password
Optional

a password for a backup piece

backupPassword If no password then the piece will not be decrypted

string
location_type
Required

a type of location

For more information see: Appliance Recovery Restore LocationType.

string
location
Required

path or url

string
location_user
Optional

username for location

locationUser User name for this location if login is required.

string As password As password
location_password
Optional

password for location

locationPassword Password for the specified user if login is required at this location.

string
sso_admin_user_name
Optional

Administrators username for SSO.

This property was added in vSphere API 6.7.

If missing or null SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.

string As password As password
sso_admin_user_password
Optional

The password for SSO admin user.

This property was added in vSphere API 6.7.

If missing or null 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.
Responses
200

Metadata Structure

Returns Appliance Recovery Restore Metadata of type(s) application/json 
"Appliance Recovery Restore Metadata Object"
string As date-time As date-time
timestamp
Required

Time when this backup was completed.

array of string
parts
Required

List of parts included in the backup.

string
version
Required

VCSA version

string
boxname
Required

Box name is PNID/ FQDN etc

boolean
sso_login_required
Optional

Is SSO login required for the vCenter server.

This property was added in vSphere API 6.7.

This property is optional because it was added in a newer version than its parent node.

string
comment
Required

Custom comment

boolean
applicable
Required

Does the VCSA match the deployment type, network properties and version of backed up VC

array of object
messages
Required

Any messages if the backup is not aplicable


400

if RestoreRequest includes a part that isn't marked as standalone

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

404

if RestoreRequest includes a part that isn't in the backup

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

Generic error

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

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.

object
data
Optional

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.

string
error_type
Required

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.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"location:"string","location_type:"string"}' https://{api_host}/api/appliance/recovery/restore?action=validate
On This Page
Appliance Recovery Operations
POST
Appliance Recovery Restore validate