Export and import workspaces

You can use the methods below to move a Budibase workspace from one Budibase installation to another or back up your workspace app and data. Admins and Developers can export any app as a JSON blob text file.

The exported file will include all Budibase DB data, data connector configurations, query configs, and builder data for all your screens.

⚠️
Security
When exporting a production workspace, be vigilant about whom you share the workspace export files with.
Are you confident you won't leak database credentials, user identity information, authentication keys, or other sensitive information?
We also recommend that you make use of the password-based app export encryption.

Export a workspace

To export a workspace, first select the workspace you wish to export from the workspace dropdown.

Next click on Settings at the bottom left of your screen.
Click on General
Scroll down to where it says Export section

This will bring up a few options to choose from:

Export latest edited will export the development version of your app, including any changes since your last publish
Export latest published will export only the last published version of your workspace

After choosing an export option, you will be given the option to Export rows from internal tables. This will include or exclude all the data rows from your internal Budibase DB tables in the export; however, data source configuration and credentials will still be exported.

In addition to that, you'll be presented with the option Encrypt my export which will allow you to add a password to encrypt your export:

💡
Environment variables
By using Environment variables 🔒, you can exclude secrets and datasource credentials from your workspace exports.

Import a workspace

You can create a workspace by importing a workspace export file.

Within the workspace picker, you should see a + symbol to the right. Click this, and it will prompt you to either Import or create a new workspace.

If you click the import button, the UI will change slightly. This will change the modal window so you can drag the workspace export file and click Create workspace to finish.

💡
Backups
Workspace backups 🔒 can be imported like you would import a manual export.
The benefit of using backups is that they will automatically be created when publishing your app.

Import into an existing workspace

You can import a workspace export into an existing workspace by going to Settings > General > Import. This is useful if you want to update the design of an existing app or add new functionality without affecting your existing data.

When importing into an existing workspace:

Existing data is preserved: Tables and rows that already exist in your workspace will not be overwritten or deleted.
New tables and rows are added: Any new tables included in the export will be created, and their associated row data will be imported.
Users and roles are protected: The internal Users table and existing roles are preserved to ensure your user management remains intact.