HP Matrix 7.2 KVM Private Cloud Backup and Restore

Appendix E: Backup and Restore REST API
Backup REST API Overview
The backup REST API provides REST calls to request a backup, check the backup status, download the completed
backup, and cancel a backup. These calls are summarized in the table below. The backup REST API calls require a
session ID for authorization, which is obtained by issuing the REST request to log in to the appliance as a user with
the "Infrastructure Administrator" role.
REST Call Request Headers
Request
Body
Response
Headers
Response
Body
Description
POST https://{appl}/rest/backups/
auth: session ID,
accept-language:
locale, accept-
content:
application/json, X-
API-Version: 1
N/A N/A
A task resource
that contains
a uri for
checking the
backup status
and an
associatedReso
urceUri for
getting detailed
information
about the
backup
Request the
appliance to
take a backup
GET https://{appl}/{uri}
auth: session ID,
accept-language:
locale, accept-
content:
application/json, X-
API-Version: 1
N/A N/A
A task resource
that contains the
current backup
status
Get backup
status
GET https://{appl}/{associatedResou
rceUri}
auth: session ID,
accept-language:
locale, accept-
content:
application/json, X-
API-Version: 1
N/A N/A
A backup
resource that
contains
detailed
information
about a backup
including the
downloadUri fo
r downloading
the backup
Get detailed
information
about the
requested
backup including
the download
URI
GET https://{appl}/{downloadUri}
auth: session ID,
accept-language:
locale, accept-
content:
application/octet-
stream;q=0.8,applic
ation/json, X-API-
Version: 1
N/A
The backup file
content
Download a
backup. Note:
The caller must
allow automatic
redirects.
GET https://{appl}/rest/backups
auth: session ID,
accept-language:
locale, accept-
content:
application/json, X-
API-Version: 1
N/A N/A
A
SimplePaginate
dCollection that
contains the last
backup
resource
Get detailed
information
about the last
backup
DELETE https://{appl}/{associatedRes
ourceUri}
auth: session ID,
accept-language:
locale, accept-
content:
application/json, X-
API-Version: 1
N/A N/A
A task resource
that contains
a uri for
checking the
backup status
Cancel a backup
35