---
title: "Back up and restore YugabyteDB Anywhere"
url: "https://docs.yugabyte.com/stable/yugabyte-platform/administer-yugabyte-platform/back-up-restore-installer/"
---

# Back up and restore YugabyteDB Anywhere

Back up and restore YugabyteDB Anywhere using YBA Installer.

Back up your YugabyteDB Anywhere installation

- [Automated](/stable/yugabyte-platform/administer-yugabyte-platform/back-up-restore-yba/)
- [Manual](/stable/yugabyte-platform/administer-yugabyte-platform/back-up-restore-installer/)

<!--THE END-->

- [YBA Installer](/stable/yugabyte-platform/administer-yugabyte-platform/back-up-restore-installer/)
- [Kubernetes](/stable/yugabyte-platform/administer-yugabyte-platform/back-up-restore-k8s/)

YugabyteDB Anywhere installations include configuration settings, certificates and keys, and other components required for creating and managing YugabyteDB universes.

If you installed YugabyteDB Anywhere using [YBA installer](/stable/yugabyte-platform/install-yugabyte-platform/install-software/installer/ "YBA installer"), use the [yba-ctl](/stable/yugabyte-platform/install-yugabyte-platform/install-software/installer/#download-yba-installer "yba-ctl") CLI to back up and restore your YugabyteDB Anywhere installation. The CLI executes the `yb_platform_backup.sh` script to back up an existing YugabyteDB Anywhere server and restore it, when needed, for disaster recovery or migrating to a new server.

## Back up YugabyteDB Anywhere

To back up your YugabyteDB Anywhere installation, perform the following steps:

1. Run the `createbackup` command, as follows:
   
   ```sh
   sudo yba-ctl createBackup <output_path> [flags]
   ```
   
   The `createBackup` command executes the `yb_platform_backup.sh` script to create a backup of your YugabyteDB Anywhere instance. Specify the `output_path` where you want the backup `.tgz` file to be stored.
   
   The `createBackup` command creates a timestamped `tgz` file for the backup. For example:
   
   ```sh
   sudo yba-ctl createBackup ~/test_backup
   ls test_backup/
   ```
   
   ```output
   backup_23-04-25-16-54.tgz
   ```
2. Verify that the backup file, with the correct timestamp, is in the specified output directory.
3. Upload the backup file to your preferred storage location and delete it from the local disk.

### Backup options

The following table describes optional flags you can include with the `createBackup` command.

Flag

Description Default 

--disable\_version\_check Exclude version metadata when creating backup. false 

--exclude\_prometheus Exclude Prometheus metric data from backup. false 

--exclude\_releases Exclude YugabyteDB releases from backup. false 

-h, --help Help for `createBackup`. 

--skip\_restart Don't restart processes during execution. true 

--verbose Display extra information in the output. false 

-f, --force (global flag) Run in non-interactive mode. All user confirmations are skipped. 

--log\_level (global flag) Log level for this command.  
Levels: panic, fatal, error, warn, info, debug, trace. "info"

## Restore YugabyteDB Anywhere

To restore the YugabyteDB Anywhere content from your saved backup, perform the following:

1. If YugabyteDB Anywhere is not installed, [install it](/stable/yugabyte-platform/install-yugabyte-platform/install-software/installer/ "install it").
2. Copy the backup file from your storage location.
3. Run the `restoreBackup` command as follows:
   
   ```sh
   sudo yba-ctl restoreBackup <input_path> [flags]
   ```
   
   Specify the `input_path` to the backup file as the only argument. For example:
   
   ```sh
   sudo yba-ctl restoreBackup ~/test_backup/backup_23-04-25-16-64.tgz
   ```

The `restoreBackup` command executes the `yb_platform_backup.sh` script to restore from the specified backup of your YugabyteDB Anywhere instance.

When finished, the restored YugabyteDB Anywhere is ready to continue managing your universes and clusters.

### Restore options

The following table describes optional flags you can include with the `restoreBackup` command.

Flag

Description Default 

--disable\_version\_check Exclude version metadata when performing restore. false 

-h, --help Help for `restoreBackup`. 

--migration Restore from a Replicated installation. For information on migrating from Replicated, refer to [Migrate from Replicated](/v2.20/yugabyte-platform/install-yugabyte-platform/migrate-replicated/ "Migrate from Replicated"). false 

--skip\_dbdrop Skip dropping the YugabyteDB Anywhere database before a migration restore. Valid only if --migration is true. false 

--skip\_restart Don't restart processes during command execution. true 

‑‑use\_system\_pg Use system path's `pg_restore` as opposed to installed binary. false 

--verbose Display extra information in the output. false 

-f, --force (global flag) Run in non-interactive mode. All user confirmations are skipped. 

--log\_level (global flag) Log level for this command.  
Levels: panic, fatal, error, warn, info, debug, trace. "info"