1. Overview
This document explains how to configure your Google Drive™ account as an Additional Destination in WHM’s Backup Configuration interface:
WHM » Home » Backup » Backup Configuration
2. Prerequisites
Before using Google Drive as a backup destination, complete the following:
- Create a Google account.
- Create a Google Cloud Console project.
- Enable the Google Drive API in the Google Console.
3. Create Your Account Credentials
To generate Google Drive credentials for WHM backups, follow these steps:
3.1 Access Google API Manager
- Go to the Google API Manager website.
- In the left navigation menu, click Credentials.
- Click Create credentials.
- Select Help me choose.
3.2 Credential Type
- Under Which API are you using?, choose Google Drive API.
- Under What data will you be accessing?, choose User Data.
- Click NEXT.
3.3 OAuth Consent Screen
If this is your first time authorizing the API, the OAuth Consent Screen will appear:
- Enter an App Name and select a User Support Email.
- Provide a developer contact email.
- Click SAVE AND CONTINUE.
3.4 Scopes
- Click ADD OR REMOVE SCOPES.
- Select the Google Drive API scope: .../auth/drive.file.
- Click Update, then SAVE AND CONTINUE.
3.5 OAuth Client ID
- Under Application type, select Web application.
- Enter a name for the application.
- In Authorized redirect URIs, add one entry per server:
https://HOSTNAME:2087/googledriveauth/callback- Click CREATE.
- In the Your Credentials section, click DOWNLOAD.
- Click DONE.
Important: Save your Client ID and Client Secret. You will need them when creating the Google Drive transport in WHM.
4. Set Up Your OAuth Consent Screen
- In the left menu, click OAuth consent screen.
- Under Test Users, click ADD USERS.
- Add the email addresses used earlier.
- Click SAVE.
5. Publish the Google Application
If you do not publish your application, Google will disable it after seven days. Refer to Google’s documentation titled Publish apps to the Google Workspace Marketplace for instructions.
6. Create a Google Drive Transport in WHM
Warning: Disable any browser popup blockers before proceeding.
Steps:
- Log in to WHM as a root-level user.
- Navigate to:
WHM » Home » Backup » Backup Configuration » Additional Destinations
- In Destination Type, select Google Drive™.
- Click Create New Destination.
- Enter a display name in Destination Name.
- Enter a folder path in Folder (optional).
- Enter your Client ID and Client Secret.
- Click Generate Credentials.
- A new tab will open—follow Google’s instructions to authorize access.
- When you see Credentials successfully generated, close the tab.
- Set a timeout value (default: 30 seconds).
- Click Save Destination.
Note: To validate the destination, click Save and Validate Destination. If you have not authorized Google Drive access, validation will fail.
Additional Documentation
For more details, refer to cPanel’s official documentation.