RELEASE NOTES/Document Backup/Document Backup v1

The new Document Backup service allows you to back up and restore your documents and your indexes. Now you can easily back up and restore your data using either of these options:

  • the dbr command line tool, which automates the process
  • REST API calls to the Document Backup service endpoints

To use the new dbr tool for document backup and restore, first download the dbr tool:

Download the dbr tool

To backup and restore documents using REST calls, use the /data/{tenant}/{type} endpoint which allows you to:

  • back up your documents by performing a GET request
  • restore your documents by performing a POST request

Good to know

  • The dbr tool uses the extended JSON format. To learn more, see the Extended JSON format
  • The dbr tool splits your data and sends it in batches of 1000 items per request
  • The dbr tool organizes your backups into separate folders named according to the convention: backup-{timestamp}


Following are the main functionalities of the Document Backup service:

Send and receive compressed data

  • Add the Accept-Encoding header and set the value to gzip in your GET request in order to receive compressed data
  • Set the Content-Encoding header value to gzipin order to send compressed data

Index support

To have your indexes backed up along with the data, you just need to use the dbr tool. The tool backs up indexes by default. If you want to use the dbr tool and still back up or restore the data without existing indexes, you can add the skipIndexes parameter to the command for the respective operation. You can also back up your data with indexes and then set the skipIndexes parameter to restore your documents without indexes.

Check the summary of your operations

You can find information about the total number of both the insert and replace operations, the number of inserted documents, and the number of replaced documents:

  • In the response body when using the service endpoints
  • In the log file and in the console when using the dbr tool


The Document Backup service allows you to import and export big data sets with simple API calls. Such availability without any constraints could cause overconsumption of resources, and therefore, serious performance loss or a potential service outage. That is why the Document Backup service introduces limits on the number of documents you can send with a single request, and on the number of requests the service processes at the same time, to mitigate those performance risks. To learn more, see the Considerations section of the Document Backup service documentation.

Enjoy the experience the Document Backup service provides! See the Document Backup service API documentation for more information.

  • Send feedback

    If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.

  • Get Help

    Use our private help channel. Receive updates over email and contact our specialists directly.

  • hybris Experts

    If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.