Modbot Docs
Discord

Server snapshots

Save your Discord server's roles, channels and permissions on a schedule or by hand, see what changed between two snapshots, download one as a file, and put one role's or one channel's permissions back.

A snapshot is a saved copy of your Discord server's roles, channels and permissions at one moment. The Discord page's Snapshots tab lists them, shows what changed between two, downloads one, and puts a role's or a channel's permissions back the way a snapshot had them. Discord stays lit in the sidebar while it is open. The command palette finds it as Discord snapshots. Its address is /discord/snapshots.

Taking snapshots

Press Take snapshot to save one now. To have Modbot save them for you, pick Weekly, Every 2 weeks or Monthly under Save on the Server snapshots card in Settings → Discord. It is Off until you do. Modbot checks every ten minutes: when the newest snapshot, however it was taken, is older than one period (or there is none), it takes one. While the bot is not connected nothing is taken, and the next check tries again. The tab shows the schedule and when the next one is due.

Modbot keeps at most 100 snapshots. The schedule keeps its 24 newest and deletes older scheduled ones as it takes new ones; when 100 are kept it deletes the oldest scheduled one to make room. Snapshots taken by hand are never deleted by the schedule: if all 100 were taken by hand, the schedule takes none until you delete one. Past 100, Take snapshot is refused until you delete one. Delete asks you to confirm.

What a snapshot holds

  • Roles: name, colour, position, the server-wide permissions, whether it is shown separately in the member list, whether anyone can mention it, and whether Discord manages it (a bot's role).
  • Channels and categories: name, type, category, position, whether it is age-restricted, and what each role's own settings allow and deny in it.

A snapshot holds no members and no Discord ids of people. Settings a channel has for a single member are not saved, and a restore leaves them alone. Channels the bot cannot see are not in the snapshot.

What changed

Under What changed, pick From snapshot and To snapshot (another snapshot, or Now, the server as it is at this moment) and press Compare. The list names each role and channel that was Added, Removed or Changed between the two, with one line for each difference, such as a rename, a moved position or a permission allowed or denied. Roles and channels are matched by their Discord id, so a rename shows as a change, not as one removed and one added.

Download

Download on a row saves that snapshot as a JSON file: every role with its permissions in words, and every channel with its role settings. It is the same for everyone who can open the tab.

Restoring one role or one channel

Restore is Off until you turn on Allow restore on the Server snapshots card in Settings → Discord. Then, under Restore, pick a snapshot, A role or A channel, and which one, and press Preview. Modbot reads your server as it is now and lists the exact change a restore would make, one line each. Nothing has changed yet. Press Restore to make it.

  • For a role, a restore sets the role's server-wide permissions to the snapshot's.
  • For a channel, a restore sets the channel's settings for each role to the snapshot's, and removes the settings for roles the snapshot did not have. A role that is gone from the server is skipped, and if that is all there is to do, the preview says Nothing to change.
  • It never makes a deleted role or channel again, never renames or moves anything, and never touches the settings for a single member.
  • If the server changed between the preview and the press, the restore is refused with a message and the preview is drawn again from the new state.
  • If nothing would change, the preview says Nothing to change.

Each restore is recorded in the audit log as Discord permissions restored from a snapshot, with the role or channel and every line of the change.

Permissions

WhoNeeds
Opening the tab, comparing, downloadingSee analytics
Taking, deleting, restoring, and the card in Settings → DiscordChange settings
The bot needsFor
Manage RolesPutting a role's permissions back, and a channel's settings for roles. Taking snapshots and comparing need no extra permission.

Discord only lets the bot change roles below its own highest role, and only allow, deny or give permissions the bot has itself. When a restore cannot be made for one of those reasons, the preview says what is missing. The bot's invite link asks for Manage Roles only while Allow restore is on; after you turn it on, open the Bot invite link again to give the bot the permission. See Permissions the bot needs.

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.

On this page