HP OneView REST API Reference

backups
backups.html[10/17/2013 10:35:53 AM]
query string that narrows the list of resources returned by a multi-
resource GET (read) request and DELETE (delete) request. The
default is no query (all resources are returned). One advantage
query has over filter is that it can have embedded ORs. A single
query parameter can do what would take multiple parameters or
multiple GET requests using filter. Use query for more complex
queries.
view Optional Return a specific subset of the attributes of the resource or collection
by specifying the name of a predefined view. The default view is
expand (show all attributes of the resource, and all elements of
collections or resources).
fields Optional
filter Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.
A general filter/query string that narrows the list of resources
returned by a multi-resource GET (read) request and DELETE
(delete) request. The default is no filter (all resources are returned).
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"
Response Description
BackupDetailList A collection of backup details stored on the
device. The detail of only one backup is
available.
Response Codes
REST API Response Codes
Examples
The following example gets the status of any backup in
progress or completed.
GET https://{appl}/rest/backups
POST Creates a backup of the appliance. The backup file must be downloaded to another storage device
for safe keeping. The backup can be taken at any time and does not require any other commands
to prepare the system for the backup. The time required for a backup to complete depends on the
amount of data the appliance is managing. The backup status can be determined by calling the
GET /rest/backups API or by using the URI returned in the location attribute of the response
header. The backup status is polled until the status attribute indicates a completed status. Once
the backup has completed successfully, then it can be downloaded for archival. The only other
notification of a completed backup is in the audit log.
Parameter Attributes Description
resource Optional