How to restore your Backup?

Pre-requisite:

  • A backup file created and sent to the backup channel. Click here to know more

  • An API platform (like Postman) to send an HTTP request

Here's the guide to restore a backup file

  1. First, grab the link to the respective backup file you wish to restore. You can get the file from the backup channel (Hover over the txt or json file -> Click on 3 dots -> Click "Get Link"). A backup link should be in the following format http://localhost:3000/group/reminder-app-backup?msg=DYg8efuxbgmPYxFQH

  2. Next, we need to get the API URL for the endpoint which we'll be using to restore the backup. You can get it by going to Reminder app's details panel. On the details panel, locate the API section and grab the URL ending with restoreBackup

    Restore backup API URL
  3. Next use your favorite API platform (like Postman) to send an API request to the URL you got in step 2. The request should be JSON based and should have a property named backupFileUrl , which is the message URL you got in step 1. Here's a sample request

curl --location --request POST 'http://localhost:3000/api/apps/private/7a8cd36b-5f7b-4177-bd7f-bfc9be908bf8/B4sjGGNj4gGY2yhh6/restoreBackup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "backupFileUrl": "http://localhost:3000/group/reminder-app-backup?msg=DYg8efuxbgmPYxFQH"
}'
Sample request

Once you initiate the restoration process, you can check the backup channel to get updates about the restoration step

Restoration process confirmation

And that was about it. By now, you should have your Reminder data restored 🎉

Last updated