Restore Backup
Guide on how to restore a backup to your Discord server
Introduction
The restore backup command allows you to restore a previously created backup to your Discord server. This will recreate all backed-up server settings, roles, channels, and optionally messages based on the backup's contents.
Usage
This command can be used by users with the "backup.restore" permission by running /backups restore
Response
When a backup is successfully restored, you'll receive confirmation with the following information:
| Field | Description |
|---|---|
| Status | The status of the restore operation |
| Restored at | The timestamp when the backup was restored |
| Details | Summary of what was restored (channels, roles, settings, etc.) |
Customization options
| Prop | Type | Description |
|---|---|---|
backup_id | string | The ID of the backup you want to restore |
password? | string | Password for encrypted backups. Required only if the backup is password protected |
channels_only? | boolean | Only restore channels, ignoring roles and server settings |
roles_only? | boolean | Only restore roles, ignoring channels and server settings |
settings_only? | boolean | Only restore server settings, ignoring channels and roles |
include_messages? | boolean | Whether to restore backed up messages (if any were included in the backup) |
delete_channels? | boolean | Whether to delete existing channels before restoring |
delete_roles? | boolean | Whether to delete existing roles before restoring |
Steps to restore a backup
Run the restore command Use `/backups restore backup_id:(your backup
id)` with any desired options
Wait for completion The restore process may take a few minutes depending
on the backup size
Verify the restoration Check that all channels, roles, and settings have
been restored as expected
Important Notes
- Make sure you have the necessary permissions in the server before attempting to restore
- If the backup is password protected, you'll need to provide the correct password
- Consider using the selective restore options (channels_only, roles_only, settings_only) if you only want to restore specific parts
- Be careful with the delete_channels and delete_roles options as they will remove existing server content
- Some elements like server boosting status and server-specific emoji may not be included in the backup
Last updated on