> For the complete documentation index, see [llms.txt](https://helpdesk.augmentt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://helpdesk.augmentt.com/back-up/salesforce-backup.md). # Salesforce Backup Augmentt's Back-Up module gives you an independent, automated backup of your Salesforce org — separate from Salesforce's own recycle bin and data recovery services, which are time-limited and don't cover every scenario (a bad mass update, a deleted custom object, a sync error that overwrites records). Backup runs on Augmentt's backup platform (delivered through our backup partner, CloudAlly) and is managed from its own portal, linked from the Augmentt app. {% hint style="info" %} You'll do the day-to-day work of managing a Salesforce backup task — connecting it, adjusting schedule, running restores — inside the dedicated backup portal, not the main Augmentt console. Look for the **Backup** link in the Augmentt navigation to get there. {% endhint %} ## What's backed up When you set up a Salesforce backup task, you choose one of two scopes up front, and it can't be changed later without creating a new task: | Backup type | Covers | | --------------------- | -------------------------------------------- | | **Production backup** | Your live Salesforce org — data and metadata | | **Sandbox backup** | A sandbox org — data and metadata | The backup captures both your Salesforce **data** (records) and **metadata** (configuration — objects, fields, workflows, layouts, etc.), so you can recover more than just row values if something in your org's setup gets damaged or overwritten. ## Before you connect a Salesforce org Salesforce requires API access to be explicitly enabled before a third-party backup can connect. In Salesforce Setup, on the profile you'll use for the backup connection: 1. Go to **Administration Setup > Manage Users > Profiles**. 2. Edit the relevant profile. 3. Under **Administrative Permissions**, check **API Enabled**, **View All Data**, and **Modify All Data**. Without these, authentication to the backup service will fail or the backup will run with incomplete access. ## Setting up the backup task 1. In the backup portal, click **+ Add Backup Task**. 2. Name the task (used in notifications and reports — you can rename it later). 3. Choose **Salesforce**. 4. Select **Production** or **Sandbox** as the backup type. 5. Click **Authenticate in Salesforce**, and when redirected, click **Allow**. 6. Sign in with your Salesforce admin credentials and authorize the connection. You'll land on the Backup Task Settings page, where the schedule and indexing options below are configured. ## Backup frequency and schedule You control both the time of day and the cadence: | Setting | Options | | ---------------- | --------------------------- | | Backup hour | Any hour, in UTC | | Backup frequency | Daily, Every 3 Days, Weekly | You can also trigger an on-demand backup at any time instead of waiting for the schedule. The backup task also throttles itself against your Salesforce API limits — a **Throughput** field caps how much of your daily Salesforce API allowance the backup is allowed to consume, from 0 up to 1.0 (100%), defaulting to 0.75 (75%). If your org is API-limit sensitive, lowering this reduces the chance of the backup competing with other integrations for API calls. ## Retention {% hint style="info" %} Per the vendor's own documentation: Salesforce backups are retained **for as long as the subscription is active**, with no fixed cutoff on how many daily snapshots are kept. If your account needs a shorter, defined retention window (e.g. for a compliance policy), contact support — this isn't a self-service setting in the backup task UI. {% endhint %} The Backup Datacenter and Retention Period shown on the task settings page are display-only; you can't change them from the UI. To change your storage region, contact support before you connect the backup — it can't be moved after setup. ## Restoring data {% hint style="warning" %} The exact restore workflow (granular record-level restore vs. full snapshot restore, and how far back you can search) isn't confirmed by the source material used to draft this page. Rather than guess at menu paths, use the **Compare** function described below as your starting point and confirm restore mechanics with support before relying on this for a live recovery. {% endhint %} What is confirmed: * By default, **Index all data for search** is enabled on the backup task, which is what powers granular search and restore (finding specific records rather than restoring a whole snapshot). If you disable indexing, you lose granular search/restore and can only browse backups by date. * Indexing works by briefly decrypting your backed-up data to build the search index; once built, both the data and the index are re-encrypted. If your organization's data-handling policy doesn't allow even temporary decryption for indexing, disable **Index all data for search** — you'll still have full snapshot access by date, just not field-level search. * You can run a **Compare** between two backup snapshots, or between a snapshot and your live production data, to see what changed — useful for pinpointing when a record was altered or deleted before you restore it. * Attachments are not included in the search index (the platform excludes attachments from the indexing process specifically) — factor that into how you locate attachment data during a restore. ## Common limitations * **Backup type is locked in at setup.** Choosing Production vs. Sandbox is a one-time decision per task — to back up both, you need two separate tasks. * **API-gated.** If API access, View All Data, or Modify All Data get revoked from the connected profile (a permission set change, a security review, etc.), the backup will show as disconnected and stop running until reauthorized. * **Region is fixed at signup.** You can't self-service move your backup's storage location; it requires a support request. ## Troubleshooting | Symptom | Likely cause | What to do | | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Backup task shows **Disconnected** | The Salesforce authentication token expired — commonly after a task has been paused for an extended period | Click the status indicator to reopen the authentication dialog and reauthorize with your Salesforce admin credentials | | You're billed for backup but can't find where it's running / see only a sign-up page | Backup was invoiced but never actually provisioned or connected for that org — a real support pattern seen on other Augmentt backup products (billing and provisioning can drift out of sync when a plan is purchased but the connection step is never completed) | Contact support to confirm whether a backup task actually exists for the org in question before assuming data is protected | | Can't log in to the backup portal from the link in Augmentt | The backup portal uses its own login, separate from your Augmentt credentials, and partner vs. customer login sections are easy to confuse when you manage multiple client orgs | Confirm which portal role you were provisioned (partner login for managing multiple tenants, customer login for a single org) and reset your backup-portal password directly rather than your Augmentt password | | Indexing / granular search unavailable | **Index all data for search** was unchecked on the task (by policy or by mistake) | Re-enable indexing on the task settings page; note this triggers a temporary decrypt-and-reindex pass | {% hint style="warning" %} Exact numeric limits — API throughput ceiling exceptions, hard caps on record volume, or SLA-backed restore time windows — are not confirmed here and should be checked with support for orgs with unusually large or complex Salesforce data. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://helpdesk.augmentt.com/back-up/salesforce-backup.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.