Skip to content

Snapshots

Snapshots are used to capture gateway configuration at a point in time. They are helpful before changes, during troubleshooting, or when a restore point is needed.

Snapshots list

When to use Snapshots

Use Snapshots when you need to:

  • view existing snapshots;
  • create a snapshot before making important changes;
  • check when a snapshot was created;
  • use a snapshot as part of a recovery process.

Understand the Snapshot list

The list shows the Snapshot Name, Type, and Created At time for every snapshot available to your role. Use search when there are many records. The actions on a row allow an authorised user to download the snapshot or import it back into the portal.

There are two snapshot types:

  • Instant Snapshot captures the available gateway configuration as one named snapshot. This is the normal choice before a broad change.
  • Service Snapshot lets you select specific services. Use it when your work is limited to one or more services and you do not need an all-purpose snapshot.

Create an instant snapshot

  1. Open Administration.
  2. Select Snapshots.
  3. Select Instant Snapshot.
  4. Enter a unique name, for example Before-routing-change-2026-09-04.
  5. Select Create and wait for the snapshot to appear in the list.

Create a service snapshot

  1. Select Service Snapshot.
  2. Enter a unique snapshot name.
  3. Search for the services you need.
  4. Select the checkbox beside each service. Use Raw View only when you need to inspect the underlying service definition.
  5. Select Create Snapshot.

Field guide

Field Required What to enter Notes
Unique name Yes A name that identifies the purpose and date. Snapshot names must be unique. Avoid vague names such as test or new.
Services For a service snapshot One or more services to include. Select only the services that belong to the planned change.

Download or import a snapshot

  • Use Download to keep a local copy or supply the snapshot to support. Store downloaded configuration securely.
  • Use Import Snapshot to restore or recreate configuration from that snapshot. Importing can replace current values, so inspect the snapshot name, type, and date first.

Warning

Importing a snapshot can affect live gateway configuration. Create a fresh snapshot of the current state and confirm the recovery plan before importing an older one.

Note

Create a snapshot before large configuration changes so there is a known point to refer back to. If snapshot buttons or row actions are missing, your user group does not have the required permission.