HP OneView REST API Reference

backups
backups.html[10/17/2013 10:35:53 AM]
Updated: October 16, 2013 4:00
MDT
API Specifications Create Read Update Delete
/rest/backups POST GET
/rest/backups/archive POST
/rest/backups/archive/{id} GET
/rest/backups/{id} GET DELETE
Resource Model
BackupDetail
BackupDetailList
HP OneView REST API Reference
backups
The backup resource manager provides REST APIs to backup the appliance, retrieve the status of a backup, cancel a
backup, upload a backup file, and download a backup file for off device storage. You must download the backup file after a
backup operation successfully completes. You can use the GET API's to poll the status of the backup. Once a backup is
created it can not be deleted from the appliance. It is overwritten each time a backup is requested. The backup file must be
uploaded to the appliance prior to starting a restore operation.
URI: /rest/backups
Method API
GET Retrieves the backup details for the backup stored on the appliance. If no backup exists, then the
response body contains a paginated collection with no items.
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0 starts
with the first available resource). If the specified count does not
return all resources within the maximum allowed time (see count),
use the start parameter to view additional resource pages. The
default value for start is 0 (first available resource).
count Optional Optional parameter that specifies the number of resources to return
from each API invocation. The number of resources returned on
each call is referred to as a page. If you specify a count, the API
attempts to return the specified number of resources, however this
may be limited due to response time constraints and/or actual
number of resources available to return. The results include the total
number of resources that match the filter or query, the actual
count returned, and the URIs to go to the next page, previous page,
or both. If necessary, you can make several requests using the URI
for the next or previous page (or different start parameters) to get
the desired count.
sort Optional The sort order of the returned data set. By default, the sort order is
based on the create time, with the oldest entry first.
query Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.
If the query is supported, the following is the way it works. A general