Create Restore Job
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Initiate restore.
Request
URLURL
https://{api_host}/rest/appliance/recovery/restore/job
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains RecoveryRestoreJobCreateRequestBody
of type application/json
(required)
{
"piece": {
"location": "string",
"location_type": "enum"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | piece | RecoveryRestoreJobRestoreRequest |
RestoreRequest Structure |
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryRestoreJobCreateResponseBody
of type application/json
RestoreJobStatus Structure
{
"value": {
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"progress": 0,
"state": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | RecoveryRestoreJobRestoreJobStatus |
RestoreJobStatus Structure |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"piece":{"backup_password":"string","ignore_warnings":false,"location":"string","location_password":"string","location_type":"enum","location_user":"string","sso_admin_user_name":"string","sso_admin_user_password":"string"}}' https://{api_host}/rest/appliance/recovery/restore/job
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
| 409 | ErrorRest | com.vmware.vapi.std.errors.feature_in_use : A backup or restore is already in progress | com.vmware.vapi.std.errors.not_allowed_in_current_state : Restore is allowed only after deployment and before firstboot |
| default | ErrorRest | Not available |
