SugarCRM SupportKnowledge BasePlatform ManagementDownloading Backups From the Backups Module

Downloading Backups From the Backups Module

Overview

Customers with instances hosted on Sugar's cloud environment may request backups of their instance's files and data for various reasons such as local sandbox development, in-depth analytics, data auditing, etc. Sugar Support can schedule and provide backups on a one-time or recurring basis, based on your organization's need. For some Sugar cloud customers, backup files are available to access and download via the Backups module in Sugar. This article covers how to download your instance's backups via the Backups module.

Prerequisites

  • You must have administrator access to Sugar to download backup files.
  • For the backup files to be available in the Backups module, you must file a case with the Sugar Support team to request one-time or recurring (bi-weekly, daily) backups for your instance. If you already have recurring backups scheduled for your instance, then it is not necessary to submit another request.

Note: Per our Master Subscription Agreement, customers running Professional or Corporate editions of Sugar can request up to two backups per month free of charge. If you wish to request more backups, they can be provided at an additional cost. Customers running Enterprise or Ultimate editions of Sugar may request daily backups at no extra cost.

Steps to Complete

The Backups module allows administrators of some Sugar instances to easily access and download backups of their Sugar instance. All available backup files appear in the Backups module for download via the module's list view, record view, or intelligence pane.

Note: Backup files expire 60 days after their creation date. Once expired, they will no longer appear in the Backups module list view. Please be sure to download backups before the 60-day expiration date, as Sugar cannot restore expired files.

Downloading Via List View

Use the following steps to download a backup file via the Backups list view:

  1. Navigate to the Backups list view by clicking "Backups" under the More tab on the navigation bar.
    MoreTab BackupsModule
  2. Use module search to find the Backup record(s) you wish to download. For more information on performing module searches, please refer to the Search documentation.
  3. Click the Download Backup button on the desired record's row.
    Backups DownloadBackup
    Alternatively, you can preview the backup record by clicking the Preview icon to the right of the desired record's row, then download the backup from the preview in the intelligence pane.
    Backups DownloadBackup IP

A tar.gz file package containing all of the backup files for your instance will begin downloading to your computer.

Downloading Via Record View

Use the following steps to download a backup file via the Backups record view:

  1. Click the backup record's name in the list view to open the record view.
    Backups ListVIew BackupRecord
  2. Click the Download Backup button in the Action field.
    Backups DownloadBackup RecordView

A tar.gz file package containing all of the backup files for your instance will begin downloading to your computer.

Downloading Via REST API

Use the following steps to download the latest backup file via the REST API.

  1. Using the development language of your choice, log into your Sugar instance. An example using curl is shown here:
    curl -X POST -H Cache-Control:no-cache -d '{  
       "grant_type":"password",
       "client_id":"sugar",
       "client_secret":"",
       "username":"<username>",
       "password":"<password>",
       "platform":"base"
    }' https://<instance>.sugarondemand.com/rest/v10/oauth2/token
    The JSON response will look similar to this:
    {  
       "access_token":"<access_token>",
       "expires_in":3600,
       "token_type":"bearer",
       "scope":null,
       "refresh_token":"<refresh_token>",
       "refresh_expires_in":1209600,
       "download_token":"<download token>"
    }
  2. Once authenticated, use the /<module>/filter POST endpoint against the ops_Backups module to fetch the latest backup record. An example using curl is shown here:
    curl -X POST -H OAuth-Token:<access_token> -H Cache-Control:no-cache -d '{
       "fields":"download_url",
       "order_by":"date_entered:DESC",
       "max_num":"1"
    }' https://<instance>.sugarondemand.com/rest/v10/ops_Backups/filter
    The JSON response will look similar to this:
    {  
       "next_offset":1,
       "records":[  
          {  
             "id":"<id>",
             "date_modified":"2016-03-20T04:37:34-07:00",
             "download_url":"<download_url>",
             "_acl":{  
                "fields":{}
             },
             "_module":"ops_Backups"
          }
       ]
    }
  3. Once you have the latest backup's URL, you can directly download the file. An example using curl is shown here:
    curl -O '<download_url>'

A tar.gz file package containing all of the backup files for your instance will begin downloading to your computer.

Application

The tar.gz file package contains backup files similar to these:
BackupFiles

Each file contains important data from your Sugar instance. For this example, the sugar7501ent folder contains the full filesystem of all files associated with your instance. The sugar7501ent_triggers.sql file contains the backup of database triggers. The sugar7501ent.sql file contains the database backup for all of the data from your Sugar instance. For more information, please refer to Migration Policy in the Sugar Cloud Policy Guide.

Last modified: 2018-07-23 15:59:21