Export a Snapshot

An export downloads the current configuration state as a file. You use a snapshot as a backup and as a safety step before you make changes.

When to use it

Click Export to:

  • create a backup before you edit or import data,

  • compare configuration changes over time,

  • share the current configuration with another team,

  • keep an audit trail of applied changes.

Export a snapshot before every import and every manual change.

What the snapshot contains

An export snapshot contains:

  • the full configuration of the selected module,

  • the data of the selected context, for example the client type,

  • the consistent state at the moment you click Export.

The snapshot contains the configuration only for the selected module and context. It does not include data from other modules.

Export a snapshot

  1. Open the module for the backup.

  2. Select the context, for example Client type, if the module asks for it.

  3. Click Export.

  4. When the download starts, save the file on your computer.

Expected result: the file is on your computer.

Name and store the snapshot

Use these rules to find a snapshot later:

  • Add the module name to the file name.

  • Add the client type, if the module has one.

  • Add a timestamp with date and time.

  • Do not overwrite older snapshots.

Example file name: <configName>-<clientType>-<date>.json/xml/zip

Store the files in versioned storage, for example ticket attachments, a shared repository, or artifact storage. Then you can see who exported what and when.

Next steps

After you export a snapshot, you can:

  • edit the configuration with a safe backup,

  • run an import with a dry-run and use the snapshot as the base,

  • restore the configuration manually, if the module allows it.

Related pages