HP OneView REST API Reference

restores
restores.html[10/17/2013 10:35:55 AM]
Updated: October 16, 2013 4:02
MDT
API Specifications Create Read Update Delete
/rest/restores POST GET
/rest/restores/{id} GET
Resource Model
RestoreResource
RestoreResourceList
HP OneView REST API Reference
restores
The restore resource manager provides REST APIs to restore an appliance and to get the status of a restore operation.
URI: /rest/restores
Method API
POST Starts a restore operation from the backup file already uploaded to the appliance. Only one restore
operation can run at a time. There is no way to cancel a restore once it has been started. The
restore operation is destructive. Any configuration changes not included in the backup file will be
lost. The appliance will raise alerts for any inconsistencies detected after the restore. If an
unrecoverable error is detected during the restore, then the appliance will be set to the factory
reset mode.
Parameter Attributes Description
Request Header Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Request Body Attributes Description
RestoreResource Required Resource that contains the ID of the backup
being used to restore
Response Description
RestoreResource Response that contains the restore details
including the URI that can be used to
poll for
updated status
Response Codes
REST API Response Codes
Examples
Initiate a restore operation on the appliance.
POST https://{appl}/rest/restores/
GET Gets the status of a restore in progress. The API returns a collection of restore status, but the
collection will contain only one status. The status for the last restore will be returned if there has
been a restore.
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0 starts