REST API - validate

appliance recovery restore: validate

Get metadata before restore

Request:

HTTP request

POST https://{server}/rest/appliance/recovery/restore/validate

Request Body Structure:

JSON

{
    "piece": {
        "backup_password": "secret string",
        "location": "string",
        "location_password": "secret string",
        "location_type": "FTP",
        "location_user": "string",
        "sso_admin_user_name": "string",
        "sso_admin_user_password": "secret string"
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
piece	restore_request	RestoreRequest Structure.
piece.backup_password	secret	a password for a backup piece Optional. backupPassword If no password then the piece will not be decrypted.
piece.location_type	string	a type of location Defines type of all locations for backup/restore Value is one of: 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
piece.location	string	path or url
piece.location_user	string	username for location Optional. locationUser User name for this location if login is required.
piece.location_password	secret	password for location Optional. locationPassword Password for the specified user if login is required at this location.
piece.sso_admin_user_name	string	Administrators username for SSO. This attribute was added in vSphere API 6.7 Optional. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.
piece.sso_admin_user_password	secret	The password for SSO admin user. This attribute was added in vSphere API 6.7 Optional. If unset SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "applicable": true,
        "boxname": "string",
        "comment": "string",
        "messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ],
        "parts": [
            "string",
            "string"
        ],
        "sso_login_required": true,
        "timestamp": "2015-01-01T22:13:05.651Z",
        "version": "string"
    }
}

Response Type:

Name	Type	Description
bold = required
value	metadata	Metadata Structure.
value.timestamp	date_time	Time when this backup was completed.
value.parts	string[]	List of parts included in the backup.
value.version	string	VCSA version
value.boxname	string	Box name is PNID/ FQDN etc
value.sso_login_required	boolean	Is SSO login required for the vCenter server. This attribute was added in vSphere API 6.7 Optional. This field is optional because it was added in a newer version than its parent node.
value.comment	string	Custom comment
value.applicable	boolean	Does the VCSA match the deployment type, network properties and version of backed up VC
value.messages	localizable_message[]	Any messages if the backup is not aplicable
value.messages[].id	string	id in message bundle
value.messages[].default_message	string	text in english
value.messages[].args	string[]	nested data

Errors:

HTTP Status Code	Type	Description
500	error	Generic error