Import and export workspaces

Overview

Import/export lets you move a workspace configuration between environments. Use it for backups, restores, and standardizing setups across teams.

You export a workspace configuration as a JSON file. You import that JSON into an existing workspace.

Import triggers a workspace import job. Track it from the Saved Workspaces panel.

circle-info

Import/export moves configuration only. It does not move data, generated outputs, or database credentials.

Permissions and prerequisites

You need Editor rights or higher on the workspace.

Before importing:

  • Create the target workspace first. See Create a workspace.

  • Make sure the workspace mode matches. See Workspace modes.

  • Make sure the same tables/columns exist in the target workspace.

  • Make sure the Syntho version matches.

When to use this

Use import/export to:

  • Reuse configurations across environments

  • Keep masking and synthesis settings consistent

  • Back up a workspace before risky changes

  • Restore previous configurations

  • Review changes in Git (JSON is readable)

  • Share a configuration with other teams

Export a workspace

Export downloads a zipped JSON file with your workspace configuration.

1

Open the workspace

Open the workspace you want to export.

2

Start export

Click the actions menu next to the workspace name. Select Export workspace.

3

Save the JSON

Your browser downloads a .json file. Store it somewhere versioned if possible.

You can also export from the Workspaces view by selecting Export in the workspace actions menu.

Import a workspace

Workspace configurations can only be imported into an existing workspace.

circle-exclamation
1

Open the target workspace

Open the workspace that should receive the configuration.

2

Start import

Click the actions menu next to the workspace name. Select Import workspace.

3

Select the zipped JSON file

Browse and select the exported zipped JSON file. Click Import.

4

Confirm overwrite

Confirm the overwrite when prompted. This starts a workspace import job.

Track the job status from View workspaces.

What’s included

The exported file contains all relevant workspace settings, including:

  • PII status for each column

  • Suggested generators

  • Assigned generators

  • Consistent mapping settings

  • Table inclusion or exclusion

  • Table and column-level configurations

  • Workspace mode and default settings

The file is human-readable. You can review and edit it before importing.

What’s not included

Import/export does not move:

  • Source/destination connection credentials or secrets

  • Actual data (source or generated)

  • Job run history, logs, or reports

How import applies changes

  • Importing overrides the current workspace configuration.

  • Only matching tables and columns are updated.

  • Missing or unmatched tables/columns are ignored.

  • If the workspace mode differs, import can fail or produce unexpected results.

  • Import between different Syntho versions is not recommended.

Best practices

  • After upgrading Syntho to latest version, export a workspace before making major changes.

  • Keep exports in Git to review diffs and audit changes.

  • Import into a staging workspace first.

  • Re-run the PII scanner if needed after importing. See Automatic PII discovery with PII scanner.

Troubleshooting

  • Nothing changed after import: the target workspace may not contain matching tables/columns.

  • Mode mismatch: align modes before importing. See Workspace modes.

  • Settings behave differently than expected: compare workspace defaults. See Workspace default settings.

  • Version mismatch: upgrade Syntho to latest before exporting. Then do the same before importing, so Syntho versions are the same.

Last updated

Was this helpful?