This is a change record, not a restorable backup. Passwords, keys and other secrets are replaced before anything is stored, so a downloaded version cannot be imported back into a device without re-entering them. There is no restore button.
Supported devices
You can replace the default with your own single-line command (tick Custom on the form). The output is still treated as the device type you selected.
Turn it on
- On the Devices page, open a gateway, or an SSH service (port 22) on a device behind a tunnel, and choose History
- Pick the device type. The form shows what the account on the device needs before the first run
- Enter the SSH username, port, and a password or a private key. Cisco devices can also take an enable password
- Choose Every night or Once a week, then Enable config history
- Press Run now to take the first snapshot. Otherwise the first one is taken at the next scheduled run
When it runs
- Every night: at 03:00 UTC plus a fixed offset per device of up to 59 minutes, so your devices are not all contacted in the same minute.
- Once a week: at the same time of day, on a weekday that is fixed per device.
- Run now: at most once every 5 minutes per device.
Who can see and change it
- Turning it on is a decision for the owner and managers. It stores an SSH login for the device and starts a scheduled login to it. An engineer or employee does not see the History button on a device that has no job yet, and reads what an owner or manager set up.
- Full access is not enough to read. An engineer with Full access can connect to every device, but sees config history only for client groups assigned to them.
- A gateway’s own configuration is for the owner and managers. Nobody else can view, create, edit, run or purge config history of a gateway itself, and the History button is not shown to them. This is recognised when the job is on the gateway, or on a service that points at the gateway’s VPN address. A service that reaches the router through its LAN address is not recognised as the gateway and follows the device rule above.
- A device outside a team belongs to its owner, who can do all of the above.
- A device or link moved into a team brings its config history with it, paused. It stays paused until the team’s owner or a manager enables it under Edit. The same applies to a link handed to the team when a member’s account is deleted. If an owner or manager moves in a device whose history they set up themselves, it keeps running. The pause is written to the audit log.
- A deleted device: the owner and managers can still read and purge what was stored. Nobody can run or edit it.
What is stored
- The configuration text after secret removal, compressed and encrypted in our database.
- Per version: when it was captured, line count, size, how many values were replaced, a hash, and who pressed Run now if it was a manual run.
- The SSH login you entered, stored encrypted. It is never shown again; the form only says whether one is stored.
- The pinned host key fingerprint, the result of the last run, and the device’s error message if it failed.
What is removed before storing
Each device type has its own rules for finding passwords, keys, hashes, pre-shared secrets and SNMP communities. Each value found is replaced with a marker like<redacted:1a2b3c4d>. The marker is derived from the value with a key that is unique to that device, so:
- a secret that changes shows up as a changed line when you compare versions;
- two fields with the same value in one configuration carry the same marker;
- markers on two different devices cannot be compared with each other.
password, secret or key followed by a value), the whole export is refused and not stored. The job page then lists the line numbers and the kind of match. The text itself is discarded.
An export is also refused when it looks incomplete, when it is less than half the size of the previous version, or when it is larger than 4 MB.
How long it is kept
- Versions are kept for your team’s device history retention period, 90 days or 1 year, which the team owner sets on the team’s page. For a device outside a team it is 90 days.
- The newest version of each device is always kept while the device exists, whatever its age. A router that has not changed for a year still has its one version.
- When a device is deleted, its stored SSH login is erased immediately and no new snapshots are taken. The versions stay until the newest one is older than the retention period, then all of them are removed.
- Expired versions are removed once a day, at 04:10 UTC.
Limits and known gaps
- No notifications. A new version, a failed run or a job that paused itself does not send an alert. Check the Config history page; each job shows the result and time of its last run.
- No restore, and no way to store an unredacted copy.
- Comparing in the browser works up to 50,000 lines across the two versions. Past that, or when the two differ too much, the page says so and you can download both.
- The job page lists the 200 most recent versions.
- A single version cannot be deleted. Purge removes all of them.
- The custom command must be one line.
Deleting the data
Open the job and use Purge at the bottom of the page: typePURGE and confirm. This deletes every stored version, the job and its SSH login. It cannot be undone. The purge is recorded in the audit log with the device name and the number of versions deleted.
Only the owner and managers can purge. For a device outside a team, its owner can.