appliance recovery restore job: create
Initiate restore.
Request:
HTTP request
POST https://{server}/rest/appliance/recovery/restore/job
Request Body Structure:
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: |
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. |
Response:
HTTP Status Code: 200
Representations:
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: |
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 |