HP Insight Control Server Provisioning 7.3 Update 1 Administrator Guide

NOTE: You can also use the Insight Control server provisioning UI to create and download a
backup file. From the Settings screen, select Actions→Create Backup (see the online help for details).
The backup REST API provides REST calls to the following:
• request a backup
• check the backup status
• download the completed backup
• cancel a backup.
These calls are summarized in the following table. The backup REST API calls require a session ID
for authorization you obtain by issuing the REST request to log in to the appliance as a user with
the role of Backup or Infrastructure administrator.
DescriptionResponse body
Response
headers
Request
bodyRequest headersREST call
Request the
appliance to
Backup resource that
contains a URI for
N.A.N.A.auth: session ID,
accept-language:
POST
https://{appl}/rest/backups/
take a
backup.
checking the backup
status and an
locale,
accept-content:
associatedResourceUriapplication/json,
X-API-Version: 1 for getting detailed
information about the
backup.
Get backup
status.
A task resource which
contains the current
backup status.
N.A.N.A.auth: session ID,
accept-language:
locale,
GET https://{appl}/{uri}
accept-content:
application/json,
X-API-Version: 1
Get detailed
information
A backup resource
which contains detailed
N.A.N.A.auth: session ID,
accept-language:
GET https://{appl}/
{associatedResourceUri}
about theinformation about alocale,
requestedbackup including theaccept-content:
backupdownloadUri forapplication/json,
X-API-Version: 1 including thedownloading the
backup. download
URI.
Download a
backup.
The backup file content.content-disposition:
the backup file
name
N.A.auth: session ID,
accept-language:
locale,
GET
https://{appl}/{downloadUri}
accept-content:
application/
octet-stream;
q=0.8,
application/json,
X-API-Version: 1
Get detailed
information
A
SimplePaginatedCollection
N.A.N.A.auth: session ID,
accept-language:
GET
https://{appl}/rest/backups
about the last
backup.
which contains the last
backup resource.
locale,
accept-content:
application/json,
X-API-Version: 1
Cancel a
backup.
A task resource which
contains a URI for
N.A.N.A.auth: session ID,
accept-language:
DELETE https://{appl}/
{associatedResourceUri}
checking the backup
status.
locale,
accept-content:
application/json,
X-API-Version: 1
Backing up the appliance 47