New features

Going forward, you do not have to provide storage space for all your backups. The Document Backup service provides cloud-based storage for all your backups. The service conveniently allows you to list all your client's backups, and to check the details of the backups.

Backup to the cloud

To back up your Document service data to the cloud, perform a POST request on the /backup-jobs endpoint.

Request with a body

You can set:

• include - specifies all of the tenants you want to back up. The default value for this field is *.
• exclude - specifies the tenants which you do not want to back up. The default value for this field is "", an empty string.
• skipIndexes - omits indexes from the backup. The default value of this field is false.

Example:

{
    "tenants" :            
        {
            "include" : "marketplace, toad",
            "exclude" : "marketdemo"
        },
    "skipIndexes": true
}

Request without a body

If you submit a backup request without a body, the system backs up the data and indexes for all the client's tenants.

Restore from the cloud

To restore your data from a backup stored in the cloud, perform a POST request on the /restore-jobs endpoint.

Request with a body

You can set:

• backupId - restores the data from a particular backup. When the backupId is not specified, the restore operation is performed from the last available backup.
• include - specifies all of the tenants to restore the data for. The default value for this field is *.
• exclude - specifies all tenants you do not want to restore. The default value for this field is "", an empty string.
• skipIndexes - omits indexes from the restore. The default value of this field is false.

Example:

{
    "backupId" : "591e953004e824001629cf26",
    "tenants" :            
        {
            "include" : "marketplace, toad",
            "exclude" : "marketdemo"
        },
    "skipIndexes" : true
}

Request without a body

If you submit a restore request without a body, the system restores the data and indexes from the latest backup, for all the client's tenants.

List your backups

To list all backups stored for your client, perform a GET request on the /backups/ endpoint.

Check the details of a backup

To view the details, such as the completion date or a list of backed up tenants, of a backup, perform a GET request on the /backups/{id}.

For all the technical details, see the Back up to the cloud and Restore from the cloud sections of the Document Backup service documentation.

New scopes

To ensure the highest standards of security and data protection, the Document Backup service requires new scopes when you call its endpoints.

From now on use the:

• hybris.document-backup_view scope for all GET requests
• hybris.document-backup_manage scope for DELETE operations on the /backups/{id} endpoint
• hybris.document-backup_backup scope for POST requests on the /backup-jobs endpoint
• hybris.document-backup_restore scope for POST requests on the /restore-jobs endpoint