Transitioning from V1 (Legacy) Backups to V2 Backups

BASH SCRIPT

This is a little script we’ve been using in testing. To use this, just need to swap in your Oauth Key (and the vCanopy URL if you’re on your own Agency instance), and set whether you want backups to be enabled. Make sure the script file is executable and then run it.

It will loop through about 2 servers a minute to handle the rate limits and resources, but it is pretty much run it and forget it:

#!/bin/bash

# Enter your OAuth API key below
API_KEY="XXXXX"

# If on Agency please update to your instance domain
gp_url="my.vCanopy.com"

# Set to false if you do not want to enable local backups for all the sites on your server
enable_local_backups="true"

update_backups_system() {
  for ((i = 1; i <= 100; i++)); do
    local servers
    servers=$(curl --location --request GET "https://${gp_url}/oauth/api/v1/server?page=$i&per_page=200" --header 'Authorization: Bearer '${API_KEY}'')
    while [[ ${servers} == *"Beep, Beep"* ]]; do
      echo "Sleeping for rate limit.... 31 seconds"
      sleep 31
      servers=$(curl --location --request GET "https://${gp_url}/oauth/api/v1/server?page=$i&per_page=200" --header 'Authorization: Bearer '${API_KEY}'')
    done

    local servers_per_page
    servers_per_page=$(echo ${servers} | jq '.data' | jq length)
    if [[ "${servers_per_page}" -eq 0 ]]; then
      printf "\n--------------------------------------------------\n"
      echo "And we are done.... exiting..."
      echo
      break
    fi

    local servers_per_page_zero_indexed
    servers_per_page_zero_indexed=$((servers_per_page - 1))
    for ((x = 0; x <= servers_per_page_zero_indexed; x++)); do
      local server_id
      server_id="$(echo ${servers} | jq '.data['$x'].id')"
      printf "\n--------------------------------------------------\n"
      echo "Server ID: ${server_id}"
      echo "Server host: $(echo ${servers} | jq '.data['$x'].label')"
      echo "IP: $(echo ${servers} | jq '.data['$x'].ip')"
      local updated_state
      updated_state="$(echo ${servers} | jq '.data['$x'].update_backups')"
      echo "Backups Updated: ${updated_state}"
      if [[ ${updated_state} == *"true"* ]]; then
        echo "--------------------------------------------------"
        continue
      fi

      echo "updating to new system..."
      [[ ${enable_local_backups} == "true" ]] &&
        echo "and enabling local backups for all sites..."

      local update_backup_system
      update_backup_system=$(
        curl --location --request PUT "https://${gp_url}/oauth/api/v1/server/${server_id}" \
          --header 'Authorization: Bearer '${API_KEY}'' \
          --header 'Content-Type: application/json' \
          --data-raw '{ "update_backups_system": true, "enable_site_local_backups": '${enable_local_backups}' }'
      )
      while [[ ${update_backup_system} == *"Beep, Beep"* ]]; do
        echo "Sleeping for rate limit.... 31 seconds"
        sleep 31
        update_backup_system=$(
          curl --location --request PUT "https://${gp_url}/oauth/api/v1/server/${server_id}" \
            --header 'Authorization: Bearer '${API_KEY}'' \
            --header 'Content-Type: application/json' \
            --data-raw '{ "update_backups_system": true, "enable_site_local_backups": '${enable_local_backups}' }'
        )
      done
      echo "${update_backup_system}"
      echo "--------------------------------------------------"
      echo "Sleeping for rate limit.... 31 seconds"
      sleep 31
    done
  done
}
update_backups_system

ADDITIONAL NOTE: CUSTOMISING THE ABOVE SCRIPT FOR REMOTE BACKUPS

For those of you who are proficient in Bash and would like to mass enable remote backups across your websites, you could look at modifying the above script using the following to identify the integration IDs for your remote backup provider of choice:

GET /integration

You could then loop through all of your sites (or all sites on a particular server) using:

GET /site
GET /server

If you wanted to only add remote backups to certain sites, you could potentially create a variable with delimiters, for example:

:site.com:other.site:next.site

And have the loop check for those:

!= *":${site}:"* ]]; then
continue