├── README.md └── cf-v4-ddns.sh /README.md: -------------------------------------------------------------------------------- 1 | Cloudflare API v4 Dynamic DNS Update in Bash, without unnecessary requests 2 | Now the script also supports v6(AAAA DDNS Recoards) -------------------------------------------------------------------------------- /cf-v4-ddns.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -o errexit 3 | set -o nounset 4 | set -o pipefail 5 | 6 | # Automatically update your CloudFlare DNS record to the IP, Dynamic DNS 7 | # Can retrieve cloudflare Domain id and list zone's, because, lazy 8 | 9 | # Place at: 10 | # curl https://raw.githubusercontent.com/yulewang/cloudflare-api-v4-ddns/master/cf-v4-ddns.sh > /usr/local/bin/cf-ddns.sh && chmod +x /usr/local/bin/cf-ddns.sh 11 | # run `crontab -e` and add next line: 12 | # */1 * * * * /usr/local/bin/cf-ddns.sh >/dev/null 2>&1 13 | # or you need log: 14 | # */1 * * * * /usr/local/bin/cf-ddns.sh >> /var/log/cf-ddns.log 2>&1 15 | 16 | 17 | # Usage: 18 | # cf-ddns.sh -k cloudflare-api-key \ 19 | # -u user@example.com \ 20 | # -h host.example.com \ # fqdn of the record you want to update 21 | # -z example.com \ # will show you all zones if forgot, but you need this 22 | # -t A|AAAA # specify ipv4/ipv6, default: ipv4 23 | 24 | # Optional flags: 25 | # -f false|true \ # force dns update, disregard local stored ip 26 | 27 | # default config 28 | 29 | # API key, see https://www.cloudflare.com/a/account/my-account, 30 | # incorrect api-key results in E_UNAUTH error 31 | CFKEY= 32 | 33 | # Username, eg: user@example.com 34 | CFUSER= 35 | 36 | # Zone name, eg: example.com 37 | CFZONE_NAME= 38 | 39 | # Hostname to update, eg: homeserver.example.com 40 | CFRECORD_NAME= 41 | 42 | # Record type, A(IPv4)|AAAA(IPv6), default IPv4 43 | CFRECORD_TYPE=A 44 | 45 | # Cloudflare TTL for record, between 120 and 86400 seconds 46 | CFTTL=120 47 | 48 | # Ignore local file, update ip anyway 49 | FORCE=false 50 | 51 | WANIPSITE="http://ipv4.icanhazip.com" 52 | 53 | # Site to retrieve WAN ip, other examples are: bot.whatismyipaddress.com, https://api.ipify.org/ ... 54 | if [ "$CFRECORD_TYPE" = "A" ]; then 55 | : 56 | elif [ "$CFRECORD_TYPE" = "AAAA" ]; then 57 | WANIPSITE="http://ipv6.icanhazip.com" 58 | else 59 | echo "$CFRECORD_TYPE specified is invalid, CFRECORD_TYPE can only be A(for IPv4)|AAAA(for IPv6)" 60 | exit 2 61 | fi 62 | 63 | # get parameter 64 | while getopts k:u:h:z:t:f: opts; do 65 | case ${opts} in 66 | k) CFKEY=${OPTARG} ;; 67 | u) CFUSER=${OPTARG} ;; 68 | h) CFRECORD_NAME=${OPTARG} ;; 69 | z) CFZONE_NAME=${OPTARG} ;; 70 | t) CFRECORD_TYPE=${OPTARG} ;; 71 | f) FORCE=${OPTARG} ;; 72 | esac 73 | done 74 | 75 | # If required settings are missing just exit 76 | if [ "$CFKEY" = "" ]; then 77 | echo "Missing api-key, get at: https://www.cloudflare.com/a/account/my-account" 78 | echo "and save in ${0} or using the -k flag" 79 | exit 2 80 | fi 81 | if [ "$CFUSER" = "" ]; then 82 | echo "Missing username, probably your email-address" 83 | echo "and save in ${0} or using the -u flag" 84 | exit 2 85 | fi 86 | if [ "$CFRECORD_NAME" = "" ]; then 87 | echo "Missing hostname, what host do you want to update?" 88 | echo "save in ${0} or using the -h flag" 89 | exit 2 90 | fi 91 | 92 | # If the hostname is not a FQDN 93 | if [ "$CFRECORD_NAME" != "$CFZONE_NAME" ] && ! [ -z "${CFRECORD_NAME##*$CFZONE_NAME}" ]; then 94 | CFRECORD_NAME="$CFRECORD_NAME.$CFZONE_NAME" 95 | echo " => Hostname is not a FQDN, assuming $CFRECORD_NAME" 96 | fi 97 | 98 | # Get current and old WAN ip 99 | WAN_IP=`curl -s ${WANIPSITE}` 100 | WAN_IP_FILE=$HOME/.cf-wan_ip_$CFRECORD_NAME.txt 101 | if [ -f $WAN_IP_FILE ]; then 102 | OLD_WAN_IP=`cat $WAN_IP_FILE` 103 | else 104 | echo "No file, need IP" 105 | OLD_WAN_IP="" 106 | fi 107 | 108 | # If WAN IP is unchanged an not -f flag, exit here 109 | if [ "$WAN_IP" = "$OLD_WAN_IP" ] && [ "$FORCE" = false ]; then 110 | echo "WAN IP Unchanged, to update anyway use flag -f true" 111 | exit 0 112 | fi 113 | 114 | # Get zone_identifier & record_identifier 115 | ID_FILE=$HOME/.cf-id_$CFRECORD_NAME.txt 116 | if [ -f $ID_FILE ] && [ $(wc -l $ID_FILE | cut -d " " -f 1) == 4 ] \ 117 | && [ "$(sed -n '3,1p' "$ID_FILE")" == "$CFZONE_NAME" ] \ 118 | && [ "$(sed -n '4,1p' "$ID_FILE")" == "$CFRECORD_NAME" ]; then 119 | CFZONE_ID=$(sed -n '1,1p' "$ID_FILE") 120 | CFRECORD_ID=$(sed -n '2,1p' "$ID_FILE") 121 | else 122 | echo "Updating zone_identifier & record_identifier" 123 | CFZONE_ID=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones?name=$CFZONE_NAME" -H "X-Auth-Email: $CFUSER" -H "X-Auth-Key: $CFKEY" -H "Content-Type: application/json" | grep -Po '(?<="id":")[^"]*' | head -1 ) 124 | CFRECORD_ID=$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/$CFZONE_ID/dns_records?name=$CFRECORD_NAME" -H "X-Auth-Email: $CFUSER" -H "X-Auth-Key: $CFKEY" -H "Content-Type: application/json" | grep -Po '(?<="id":")[^"]*' | head -1 ) 125 | echo "$CFZONE_ID" > $ID_FILE 126 | echo "$CFRECORD_ID" >> $ID_FILE 127 | echo "$CFZONE_NAME" >> $ID_FILE 128 | echo "$CFRECORD_NAME" >> $ID_FILE 129 | fi 130 | 131 | # If WAN is changed, update cloudflare 132 | echo "Updating DNS to $WAN_IP" 133 | 134 | RESPONSE=$(curl -s -X PUT "https://api.cloudflare.com/client/v4/zones/$CFZONE_ID/dns_records/$CFRECORD_ID" \ 135 | -H "X-Auth-Email: $CFUSER" \ 136 | -H "X-Auth-Key: $CFKEY" \ 137 | -H "Content-Type: application/json" \ 138 | --data "{\"id\":\"$CFZONE_ID\",\"type\":\"$CFRECORD_TYPE\",\"name\":\"$CFRECORD_NAME\",\"content\":\"$WAN_IP\", \"ttl\":$CFTTL}") 139 | 140 | if [ "$RESPONSE" != "${RESPONSE%success*}" ] && [ "$(echo $RESPONSE | grep "\"success\":true")" != "" ]; then 141 | echo "Updated succesfuly!" 142 | echo $WAN_IP > $WAN_IP_FILE 143 | exit 144 | else 145 | echo 'Something went wrong :(' 146 | echo "Response: $RESPONSE" 147 | exit 1 148 | fi 149 | --------------------------------------------------------------------------------