Files
ddns-updater/docs/cloudflare.md
2024-01-29 09:37:33 +00:00

1.4 KiB

Cloudflare

Configuration

Example

{
  "settings": [
    {
      "provider": "cloudflare",
      "zone_identifier": "some id",
      "domain": "domain.com",
      "host": "@",
      "ttl": 600,
      "token": "yourtoken",
      "ip_version": "ipv4"
    }
  ]
}

Compulsory parameters

  • "zone_identifier" is the Zone ID of your site, from the domain overview page written as Zone ID
  • "domain"
  • "host" is your host and can be "@", a subdomain or the wildcard "*". See this issue comment for context. This is left as is for compatibility.
  • "ttl" integer value for record TTL in seconds (specify 1 for automatic)
  • One of the following (how to find API keys):
    • Email "email" and Global API Key "key"
    • User service key "user_service_key"
    • API Token "token", configured with DNS edit permissions for your DNS name's zone

Optional parameters

  • "proxied" can be set to true to use the proxy services of Cloudflare
  • "ip_version" can be ipv4 (A records), or ipv6 (AAAA records) or ipv4 or ipv6 (update one of the two, depending on the public ip found). It defaults to ipv4 or ipv6.

Special thanks to @Starttoaster for helping out with the documentation and testing.