View Source

QuickBuild database backup can be taken via RESTful call.
h1. Syntax
The backup can be taken by posting XML representation of the database backup request object to below url:
{code}http://localhost:8810/rest/backup{code}
A sample XML of backup request object is like below:
{code}
<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>
{code}

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

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

h1. Demo
We use [curl|http://curl.haxx.se/] to demonstrate how to backup the database:
# Save the sample backup request XML described above to file _tempfile.xml_.
# Post content of _tempfile.xml_ to QuickBuild using below command:
{code}curl -X POST -u admin:admin -d@tempfile.xml http://localhost:8810/rest/backup{code}