Export a Snapshot

Exporting a snapshot lets you download the current configuration state as a file. Snapshots are commonly used as backups and as a safety measure before making changes.

When to use export

Use Export when you want to:

  • create a backup before editing or importing data,

  • compare configuration changes over time,

  • share the current configuration with another team,

  • keep an audit trail of applied changes.

Exporting before any import or manual change is considered a best practice.

What is included in a snapshot

An export snapshot contains:

  • the full configuration for the selected module,

  • data scoped to the selected context (for example, client type),

  • a consistent state as of the moment you click Export.

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

Steps to export a snapshot

To export the current configuration:

  1. Open the module you want to back up.

  2. Select the required context (for example, Client Type), if prompted.

  3. Click Export.

  4. When the download starts, save the file locally.

Naming and storage recommendations

To make snapshots easy to identify later:

  • include the module name in the filename,

  • include the client type (if applicable),

  • include a timestamp (date and time),

  • avoid overwriting older snapshots.

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

Store exported files in versioned storage (ticket attachments, shared repository, or artifact storage) so you can trace who exported what and when.

What to do next

After exporting a snapshot, you can:

  • proceed with editing configuration safely,

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

  • restore configuration manually if needed (depending on module capabilities).

For safe imports, see: Import with Dry-run.