API Backups extension enables you to make backups directly on your hosting provider, a Cloud Manager, or through a VPS.

The Extension currently supports these Cloud Managers:

• Cloudways
• GridPane (Must be the GridPane Owners Account & have a Developer Plan or above)

and these VPS Providers:

• Vultr
• Akamai (Linode)
• DigitalOcean.

Install the API Backups Extension

1. Go to your MainWP Dashboard
2. Go to the MainWP > Extensions page
3. Click the Install Extensions button
   
4. Locate the API Backups extension and select it
5. Click the Install button
6. Once the installation process is complete, click the Activate Extensions button.
   

How to connect the Extension to a Cloud Manager or a VPS

The links and detailed steps for each Cloud Manager and VPS provider are directly in the Extension itself.

However, the steps required for all providers are very similar and require you to grab the API key from their website, and simply enter it in the extension settings.

Additional step for VPS Providers (Vultr, Akamai and DigitalOcean)

1. Go to the Child Site Overview > Edit page
2. Locate the Backup API Provider Setting section of the Edit page
3. Select a VPS provider from the Dropdown and enter the Instance ID
   
4. Click the Save Settings button at the bottom of the page

How to create Backups

For individual sites

1. Go to your MainWP Dashboard
2. Navigate to MainWP > Extensions > API Backups page
3. Locate the desired site in the table
4. Click the Backup action from the ellipsis menu
   
   NOTE: The process can take some time to complete, depending on the size of the site and the speed of the host.

For multiple sites

1. Go to your MainWP Dashboard
2. Navigate to MainWP > Extensions > API Backups page
3. Locate the desired sites in the table and mark the checkbox next to them
4. Click the Backup Selected Sites button
   NOTE: The process can take some time to complete, depending on the size of the site and the speed of the host.

How to restore backups

1. Go to your MainWP Dashboard
2. Navigate to MainWP > Extensions > API Backups page
3. Locate the desired site in the table
4. Click the Manage Backups action from the ellipsis menu
5. Locate the desired backup in the table
6. Click the Restore Backup action from the ellipsis menu
   
   NOTE: The process can take some time to complete, depending on the size of the site and the speed of the host.

Location of Backups

MainWP API Backups Extension does not control backup storage settings. The Extension uses API requests provided by supported companies to trigger the backup process. Once the process is triggered, your hosting handles the rest. That includes backup storage.

Backups created from our Extension will be stored in the location that your host/cloud manager has set and uses for storing backups.

MainWP API Backups Extension does not use any custom location!

For more information about the location of backups, please visit the respective help documentation:

• GridPane: https://gridpane.com/kb/v2-backups-configuration-purging-exports/#location
• Cloudways: https://support.cloudways.com/en/articles/5123346-how-to-download-the-backup-of-your-application
• Vultr: https://www.vultr.com/docs/vps-automatic-backups/
• DigitalOcean: https://docs.digitalocean.com/products/images/backups/
• Akamai (Linode): https://www.linode.com/docs/products/storage/backups/