Create and Set Your Dropbox API Token

3 min read

Currently the new backup system is BETA only. 

Please do not rely on Beta Backups V2 for your production websites. By running these backups you are agreeing to also maintain separate comprehensive third-party backups of all sites with Backups V2 enabled.

Any ticket submitted for a website with a Backups v2 issue will be treated primarily as a bug report and there is no critical/urgent support or support guarantees.

Activating V2 Backups

To activate backups 2.0 head to your Servers page and click on the name of the server you wish to activate it on.

Warning: This will disable Borg and purge all existing Borg backups from your system. You are responsible for ensuring you have existing backups in place. By enabling Backups v2 you accept full responsibility for this action and confirm you have alternative backups in place. Only enable if you agree to these conditions. Once enabled, this can not be disabled. Borg is going back to the Delta Quadrant.

Dropbox needs no introduction. It’s a solid and reliable storage provider and this article assumes that you already have a Dropbox account. 

Somewhat unfortunate timing, Dropbox has released a new version of their API as we’ve been developing our backup system. For the moment, our system works with the legacy API. 

There are two methods detailed below for generating an API token that will work with GridPane. 

Step 1. Create Your Dropbox API Token

Below outlines 2 different methods for generating your API token. You can choose either, but the quickest and easiest way is to follow Method 1 below.

Method 1. Quickly Create Your Key via Duplicacy.com

Head to https://duplicacy.com/dropbox_start.html and click the Continue to get started:

You’ll be taken to Dropbox to authorize Duplicacy to create its own folder (Apps > Duplicacy). Click the Allow button to continue:

Here you’ll be presented with your API token that you can add to your GridPane account:

Copy the token and proceed to Step 2 below.

Method 2. Create Your Token Within Dropbox

To begin, first sign in to your dropbox account and then head over to Dropbox App Console here: https://www.dropbox.com/developers/apps

Here there’s a small blue Create App button. Go ahead and click on this to create a new app.

Here you need to select: –

  1. Scoped Access
  2. App folder
  3. Name your App

And then click the blue Create App button.

You will automatically be taken to your apps management page. Here, first click through to the permissions tab and give your API the correct permissions and click the Submit button:

Once selected, click back to the Settings tab and scroll down approximately halfway to the “Oauth” section.

Here you’ll see the option to generate an access token – “Generated access token” followed by a button labeled “Generate“, and also the “Access token expiration” dropdown.

Set the expiration to “No Expiration“.

Next, click the Generate button and your API token will be displayed. Copy it and then head over to your GridPane account.

IMPORTANT: On very rare occasions Dropbox will create a token that begins with a dash “-“, e.g:

-od2UzsdgfGGGSDfewfregg8gLLLLq_FAWS5wtAnmHLvZa6QZLq99RkblsDD0qub

If this happens, please refresh the page and hit the generate button again as the “-” will be read as a flag on the server and will result in an error.

Step 2. Add your Dropbox API Token to GridPane

Back in your GridPane account, click through to your settings page:

Here, click through to the Integrations page, click Backup Providers, and then Dropbox:

Give your key a name, enter your API token, and click the Create button.

You’re all set!

To learn how to configure remote backups for your websites check out the following article for a full walk-through:

Remote Website Backups

Further Reading

For further information about how backup systems work, the available options for configuring them, and for setting up remote backups (available on V2), please see the articles listed below.

Strategy

Recommended Backup Strategy

V2 Backups

V1 Backups