This documentation relates to QuickBuild 10.0.x
Select here if you are using a different version

Backup Database

Added by Robin Shen, last edited by Robin Shen on Jan 13, 2019
QuickBuild Documentation

QuickBuild database backup can be taken via RESTful call.

Syntax

The backup can be taken by posting XML representation of the database backup request object to below url:

http://localhost:8810/rest/backup

A sample XML of backup request object is like below:

<com.pmease.quickbuild.web.page.administration.BackupNowOption>
  <!-- Destination file for the backup -->
  <backupTo>/path/to/backup.zip</backupTo>

  <!-- Whether or not to exclude builds in the backup -->
  <excludeBuilds>false</excludeBuilds>

  <!-- Whether or not to exclude measurement data in the backup -->
  <excludeMeasurements>false</excludeMeasurements>

  <!-- Whether or not to exclude audits in the backup -->
  <excludeAudits>false</excludeAudits>

  <!-- Whether or not to clear passwords in the backup -->
  <clearPasswords>false</clearPasswords>
</com.pmease.quickbuild.web.page.administration.BackupNowOption>

The response is of mime type text/plain and the content is absolute path to the backup file.

Security

You will need to use http BASIC authentication to login as administrator to do the backup.

Demo

We use curl to demonstrate how to backup the database:

  1. Save the sample backup request XML described above to file tempfile.xml.
  2. Post content of tempfile.xml to QuickBuild using below command: 
    curl -X POST -u admin:admin -d@tempfile.xml http://localhost:8810/rest/backup

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.