ddns-scripts-cloudflare: document API Token auth in comments
authorDominic Greenberg <[email protected]>
Fri, 3 Oct 2025 22:32:27 +0000 (00:32 +0200)
committerFlorian Eckert <[email protected]>
Mon, 6 Oct 2025 06:08:38 +0000 (08:08 +0200)
adjust comments documenting the already supported API Token auth
adjust comments with URLs that changed in the meantime
adjust comment regarding CF API documentation URL, points to the scripts relevant DNS section

Signed-off-by: Dominic Greenberg <[email protected]>
net/ddns-scripts/files/usr/lib/ddns/update_cloudflare_com_v4.sh

index 8212931953e4afb9919cefe8d0a9f3dceadf11b6..b88672c12c8895ae68e962a9f50cd19d277a5105 100644 (file)
@@ -6,13 +6,15 @@
 #.based on Ben Kulbertis cloudflare-update-record.sh found at http://gist.github.com/benkulbertis
 #.and on George Johnson's cf-ddns.sh found at https://github.com/gstuartj/cf-ddns.sh
 #.2016-2018 Christian Schoenebeck <christian dot schoenebeck at gmail dot com>
-# CloudFlare API documentation at https://api.cloudflare.com/
+# CloudFlare API documentation, section DNS at https://developers.cloudflare.com/api/resources/dns/
 #
 # This script is parsed by dynamic_dns_functions.sh inside send_update() function
 #
 # using following options from /etc/config/ddns
-# option username  - your cloudflare e-mail
-# option password  - cloudflare api key, you can get it from cloudflare.com/my-account/
+# option username  - "Bearer" or your Cloudflare e-mail, depending on the type of credentials used
+#                    for API Token, use "Bearer"; otherwise, with Global API Key, use your Cloudflare e-mail
+# option password  - Your API Token or your Global API Key, you can create/get either at
+#                    https://dash.cloudflare.com/profile/api-tokens
 # option domain    - "[email protected]"
 # option param_opt - (Optional) key=value pairs that are separated by space
 #                    if duplicate keys found, only the last occurrence will be used