REST API - create

appliance recovery restore job: create

Initiate restore.

Request:

HTTP request

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

Request Body Structure:

JSON

{
    "piece": {
        "backup_password": "secret string",
        "ignore_warnings": true,
        "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.
piece.ignore_warnings	boolean	The flag to ignore warnings during restore. This attribute was added in vSphere API 6.7 Optional. If unset, validation warnings will fail the restore operation.

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ],
        "progress": 1,
        "state": "FAILED"
    }
}

Response Type:

Name	Type	Description
bold = required
value	restore_job_status	RestoreJobStatus Structure.
value.state	string	process state Defines state of backup/restore process Value is one of: FAILED: Failed INPROGRESS: In progress NONE: Not started SUCCEEDED: Completed successfully
value.messages	localizable_message[]	list of messages
value.messages[].id	string	id in message bundle
value.messages[].default_message	string	text in english
value.messages[].args	string[]	nested data
value.progress	long	percentage complete

Errors:

HTTP Status Code	Type	Description
400	feature_in_use	A backup or restore is already in progress
400	not_allowed_in_current_state	Restore is allowed only after deployment and before firstboot
500	error	Generic error