Management Console backup & restore

Backup

The Management Console back ups objects definitions: Agents, Jobs and Job runs, groups, profiles, users and user groups, cloud connectors, API key, etc. Backups are created automatically but can be also created on demand.

Excluded from the backup

The following items are not included in the backup:

Events
Agents' performance and data transfer statistics
Management Console's configuration file
Management Console's debug logs

Backup schedule

By default, backups are created daily at 6 AM, and the backup files are retained for 30 days. The backup frequency and the time interval the backup files are stored are configurable. For details, see Change backup frequency.

Backup files location

Default backup files locations:

Windows: C:\ProgramData\Resilio\Connect Server\data\server_backup
Linux: {resilio-connect-server}/var/data/server_backup/

You can change the default backup files location. For details, see Change backup files location.

Change backup frequency

The backup schedule is defined by the schedule parameter in the backup section of the configuration file.

"backup": {
    "cleanup": "0 0 6 * * *",
    "schedule": "0 0 6 * * *",
    "ttl": 30
},

The schedule parameter's syntax is similar to crontab's with the only difference being that the values are second, minute, hour, day of month, month, day of week. The default value of "0 0 6 * * *" represents every day at 6 AM.

Change backup files location

To change the backup files location, add the path parameter in the backup section of the Management Console's configuration file, then restart Resilio Active Everywhere Management Console service.

"backup": {
    "schedule": "*/5 * * * *",
    "cleanup": "*/5 * * * *",
    "ttl": 30,
    "path": "C:\\srv_bak\\backups"
},

Tip

On Windows, make sure to escape the backslash characters.

No symbolic links

Do not attempt to use symbolic links to point backup to a different location.

Create a backup on demand

You can create a backup on demand using either the Management Console or the API.

Management ConsoleAPI

To create a backup on demand using the Management Console:

In the Management Console, select Settings > Backups.
Click BACKUP NOW.

To create a backup on demand using the Resilio API, use the Backup - Create backup API request.

curl --location --request POST 'https://mc-resilio:8446/api/v2/backup' \
--header 'Authorization: Token IDDQDIDKFA'

Restore from a backup

You can restore your configuration from a backup using either the Management Console, the srvctrl command line tool or the API.

Management ConsoleCommand lineAPI

To restore the Management Console's settings from a backup using the Management Console:

In the Management Console, select Settings > Backups.
Select a backup that you want to restore, then click RESTORE.
Click Continue to proceed.

To restore the Management Console's settings from a backup using the srvctrl command line tool:

Open an elevated instance of the command line interface and navigate to where the Resilio Management Console has been installed.
Stop the Management Console service:
```
./srvctrl stop
```
Restore the configuration:
```
./srvctrl restore backup_1763473962652
```

To restore the Management Console's settings from a backup using the Resilio API, use the Backup - Restore backup API request.

curl --location --request POST 'https://mc-resilio:8446/api/v2/backup/restore/<backup_id>' \
--header 'Authorization: Token IDDQDIDKFA'

Determine backup identifier

Use the Backup - Get backups API request to retrieve the list of backups and their identifiers.

curl --location 'https://192.168.0.50:8446/api/v2/backup' \
--header 'Authorization: Token R3E7VYL6VLH4O4ETURCN6HWCDYOJGA6JMFVC7EWFIX346CRAUYNA'