Skip to content

cloudflare.md

Latest commit

 

History

History
40 lines (32 loc) · 1.83 KB

cloudflare.md

File metadata and controls

40 lines (32 loc) · 1.83 KB

Cloudflare

Configuration

Example

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

Compulsory parameters

  • "zone_identifier" is the Zone ID of your site, from the domain overview page written as Zone ID
  • "domain" is the domain to update. It can be example.com (root domain), sub.example.com (subdomain of example.com) or *.example.com for 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.
  • "ipv6_suffix" is the IPv6 interface identifier suffix to use. It can be for example 0:0:0:0:72ad:8fbb:a54e:bedd/64. If left empty, it defaults to no suffix and the raw temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.

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