Sites
      Back to home
      1. MainWP KB
      2. Sites

      API Backups

      The API Backups feature facilitates backups directly through hosting providers, cloud managers, or VPS, supporting specific platforms and requiring API key setup for connectivity.


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

      The feature currently supports

      • cPanel (Native and WP Toolkit) backups
      • Plesk (WP Toolkit) backups

      these Cloud Managers:

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

      and these VPS Providers:

      • Vultr
      • Akamai (Linode)
      • DigitalOcean.

      How to connect the API Backups to a Cloud Manager or a VPS

      The links and detailed steps for each Cloud Manager and VPS provider are directly in the API Backups 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 settings.

       

      Assign VPS provider to Child Sites

      This step is necessary for all providers except for Cloudways and GridPane.

      1. Go to the Child Site Overview > Edit page
      2. Locate the Backup API Provider Settings 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 connect and configure API Backups for individual child sites

      1. Go to the Child Site Overview > Edit page
      2. Locate the Backup API Provider Settings section of the Edit page

      For all providers except for Cloudways and Gridpane, you will be able enter hosting information for that specific site.

      Allowing you to configure multiple accounts of the same hosting provider for your child sites.

       

      Note for cPanel Backups

      New cPanel installations have Backups disabled by default, so we'd recommend contacting your hosting support and have them enable the Backups.

      If you are comfortable enabling them yourself and also have access to WHM, please follow these instructions:

      1. Force a Backup ( Terminal Command )
        https://support.cpanel.net/hc/en-us/articles/360050631974-How-can-I-change-the-backup-time-#:~:text=By default%2C this cronjob will of WHM >> Backup Configuration.
      2. Backup Meta Data Script ( Terminal command )
        https://docs.cpanel.net/whm/scripts/the-backups_create_metadata-script/

      cPanel Automatic Backups run on a CRON & may need to be manually run via $Terminal the first time if there are no current Automatic Backups available. 


      How do you know if you need to run the commands?

      The system disables cPanel’s File and Directory Restoration interface (cPanel » Home » Files » File and Directory Restoration) and WHM’s File and Directory Restoration interface (WHM » Home » Backups » File and Directory Restoration). The interfaces display a RED NOTIFICATION that explains why the feature is unavailable on these pages.

      Technical Resources Meta Data Script is talked about in more detail here.


      IMPORTANT

      Due to the way cPanel restores files, for cPanel Accounts with more than one WordPress site installed, it’s recommended that all sites be installed in their own folder.

      Site Paths ARE CASE SENSITIVE

      Example Multi-site environment:

      URL: https://{your-site-url.com}/Child-1/

      Site Path..: /public_html/Child-1/

      URL:       https://child-2.{your-site-url.com}/

      Site Path..: /public_html/child-2/


      Example Single-site environment:

      URL: https://{your-site-url.com}

      Site Path..: /public_html/

      How to create Backups

      For individual sites

      1. Go to your MainWP Dashboard
      2. Navigate to MainWP > Sites > API Backups page
      3. Locate the desired site in the table
      4. Click the Backup action from the ellipsis menu
        chrome_5XUg67SRB0

        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 > Sites > 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
        chrome_jAOYPTDv63
        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 > Sites > 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
        chrome_KDPiKQzDyP

        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

      The MainWP API Backups feature does not control backup storage settings. The API Backups 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 feature will be stored in the location that your host/cloud manager has set and uses for storing backups.

      MainWP API Backups feature does not use any custom location!

      Note for cPanel DB Backups - Manual cPanel DB Backups are created via the MySQLdump command on the Child Site Server & then placed inside the /wp-content/uploads/mainwp/api_db_backups/ folder.

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