> ## Documentation Index
> Fetch the complete documentation index at: https://developer.upsun.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Back up an environment

> See how to protect yourself from potential data loss by backing up your environments so they can be restored later.

export const BackupIcon = () => <svg width="24px" height="24px" style={{
  display: 'inline',
  verticalAlign: 'middle'
}}>
    <title id="backup-icon">Backup</title>
    <path d="M20,13H4c-0.6,0-1,0.5-1,1v6c0,0.5,0.4,1,1,1h16c0.5,0,1-0.5,1-1v-6C21,13.4,20.5,13,20,13L20,13z M7,19 c-1.1,0-2-0.9-2-2s0.9-2,2-2s2,0.9,2,2S8.1,19,7,19L7,19z M20,3H4C3.4,3,3,3.4,3,4v6c0,0.6,0.4,1,1,1h16c0.5,0,1-0.4,1-1V4 C21,3.4,20.5,3,20,3L20,3z M7,9C5.9,9,5,8.1,5,7s0.9-2,2-2s2,0.9,2,2S8.1,9,7,9L7,9z" fill="current"></path>
  </svg>;

When you're making changes to your apps,
you want to be sure those changes only improve things and don't make you lose any data.
You also want to have a disaster recovery plan in place.
Backups help you protect yourself against potential data loss.

You might want to create backups of your live environment before merging a different environment into it
or each time you increase the storage space of your services.

You also have regularly scheduled automated backups of your production environments to cover most cases.

Note that you can only create backups and restore active environments.
To work with an [inactive environment](/docs/glossary#inactive-environment),
first activate it.

## How backup and restore works

1. As an [admin user](/docs/administration/users), you can do a backup of your environment.
   This backup includes the complete data and code of the environment.
   All persistent data from all running [services](/docs/add-services)
   and any files stored on [mounts](/docs/configure-apps/image-properties/mounts) are included.
   The backup is stored internally on Upsun.
   That is, the backup can be applied to environments on Upsun, but it can't be downloaded.
   If you need to download backups, instead [export your mount and service data](/docs/core-concepts/common-tasks/exporting)).

2. You restore your environment using the backup.
   At this point, the data and code from the backup are restored to ensure a consistent state.
   The latest code in your repository may have been modified such that it no longer works correctly with the old, restored data.

   <Warning>
     Upsun does not modify your Git repository. Any further changes you make use the latest code in your repository.
   </Warning>

3. Depending on your needs, you can do the following:

   a) To use the code from the time of the backup as a baseline for future changes,
   make sure you restore it yourself in your Git repository.
   To do so, use Git commands such as `revert`.

   b) To use your latest code instead, just redeploy your environment or push a new change.

<Note>
  You may not want the code from the backup to be restored at step 2.
  For instance, if you have deleted containers since the backup, you may not want them to be restored with the backup.

  In this case, you can opt out of restoring the code.
  To do so, when you restore your backup, use the `--no-code` flag.

  Also, see [how resource allocation works](/docs/manage-resources/resource-init#backup-restoration) when you restore a backup.
</Note>

## Backups and downtime

By default, creating a manual backup causes a momentary pause in site availability so that all requests can complete.
This means the environment is backed up in a known consistent state.
The total interruption is usually only 15 to 30 seconds.
Any requests during that time are held temporarily, not dropped.

To avoid this downtime, use [live backups](#live-backups).

For consistent backups, create the backups during non-peak hours for your site.

## Data retention

### Manual backups

[Manual backups](/docs/environments/backup#create-a-manual-backup) are retained until you delete them or replace them with another backup.

You can configure the maximum number of manual backups. Once that number is reached, any new manual backup automatically replaces the oldest backup.

### Automated backups

Automated backups are retained for 2 days when you use the [default backup policy](#default-backup-policy)
(meaning, 2 days worth of backups are retained at any given point).

When you [configure your own automated backup policy](#configure-a-backup-policy),
the retention time varies based on that configuration.

Automated backups are always [live](#live-backups).

## Backup policy

### Default backup policy

By default, Upsun provides 1 automated backup a day for your production environment,
with a [2-day retention](/docs/security/data-retention) (2 days worth of backups are retained at any given point).

You can [configure your own backup policy](#configure-a-backup-policy).
The default backup policy is equivalent to a custom backup policy using a `1d` interval and a count of `2` (see below).

### Configure a backup policy

Upsun allows you to fully configure your own backup policy.
You can setup a different automated backup schedule per environment type (production, staging, and development environments).

On a given environment type, you can configure:

* The total number of backups (manual and automated)
* The total number of manual backups specifically
* Multiple schedules for automated backups

An automated backup schedule is composed of an interval and a count.<br />
The interval defines the frequency of the backups.
An interval can be a couple of hours, days, weeks, months, or years.
To configure an interval, use the following values:

* `h` for hour
* `d` for day
* `w` for week
* `M` for month
* `y` for year

The count defines the number of backups to retain.

### Configuration examples

To take a backup every day and keep up to 7 backups,
run the following command:

```bash Terminal theme={null}
upsun project:curl settings -X PATCH \
   -d '{
       "data_retention": {
          "production": {
             "default_config": {
                "schedule": [
                  {"interval": "1d", "count": 7},
                 ]
              }
           }
        }
      }'
```

#### Configure multiple automated backup schedules

You can use multiple schedules to implement you own backup policy.
For instance, you may want to keep multiple recent backups and fewer older backups,
using a command similar to the following:

```bash Terminal theme={null}
upsun project:curl settings -X PATCH \
   -d '{
       "data_retention": {
          "production": {
             "default_config": {
                "schedule": [
                  {"interval": "1d", "count": 7},
                  {"interval": "1w", "count": 4},
                  {"interval": "1M", "count": 12}
                 ]
              }
           }
        }
      }'
```

The command results in:

* A backup every day for 7 days
* A backup every week for 4 weeks
* A backup every month for 12 months

#### Set a limit for backups

To configure the maximum number of backups (automated and manual backups alike) on your production environment,
run a command similar to the following:

```bash Terminal theme={null}
upsun project:curl /settings -X PATCH -d '{"data_retention": {"production": {"max_backups": 10}}}'
```

To configure the maximum number of manual backups on the production environment,
run a command similar to the following:

```bash Terminal theme={null}
upsun project:curl /settings -X PATCH -d '{"data_retention": {"production": {"default_config":  {"manual_count": 1}}}}'
```

## Live backups

You can create backups without any downtime.
This means your environment is running and open to connections during the backup.

Because the connections may come in during backup creation, live backups may have data inconsistencies among containers.
They may make restorations less reliable.
To avoid such issues, schedule [manual backups](#create-a-manual-backup) during non-peak hours,
when the short amount of downtime is least noticed.

You can create a manual live backup on a Grid project:

<Tabs>
  <Tab title="Using the CLI">
    Use the `--live` flag:

    ```bash theme={null}
    upsun backup:create --live
    ```
  </Tab>

  <Tab title="In the Console">
    When [creating the backup](#create-a-manual-backup), select **Run live backup** in the last step.
  </Tab>
</Tabs>

## Create a manual backup

You can create a manual backup using the [CLI](/cli) or in the [Console](/docs/administration/web).

<Tabs>
  <Tab title="Using the CLI">
    ```bash theme={null}
    upsun backup:create
    ```
  </Tab>

  <Tab title="In the Console">
    1. Navigate to the environment you want to back up.
    2. Click **Backups**.
    3. Click <BackupIcon /> **Backup**.
    4. Click **Backup**.
  </Tab>
</Tabs>

See more information on [backup policies](#backup-policy) and [data retention](#data-retention).

### Automate manual backups

You can also automate the process of creating manual backups through [cron jobs](/docs/configure-apps/image-properties/crons).
The cron job uses the CLI command to back up the environment.
It requires you to [set up the CLI on the environment with an API token](/cli/api-tokens#authenticate-in-an-environment).

Although this process is automated,
backups created in this way count as [manual backups](#manual-backups).
They don't affect the automated backups taken as part of [a schedule](#configure-a-backup-policy).

## Physical storage location

Backups are stored as binary large objects separate from your environments.
This storage is replicated over multiple data centers in different locations
[within the region your project is hosted in](https://upsun.com/trust-center/security/data-security/).
This means that in the rare event a data center becomes unavailable, your backups are still available.