Cloudflare

With the Cloudflare integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], you can keep your Cloudflare DNS records up to date.

The integration runs every hour, but can also be triggered by running the cloudflare.update_records action.

Requirements

The setup requires an API Token created with Zone:Zone:Read and Zone:DNS:Edit permissions for all zones in your account.

An easy way to create this is to start with the “Edit zone DNS” template then add Zone:Zone:Read to the permissions.

Cloudflare API Tokens Guide

Configuration

To add the Cloudflare integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Cloudflare.

  • Follow the instructions on screen to complete the setup.

Additional information

Usage of external service

This integration uses the whoami service from home-assistant/services.home-assistant.io to set the public IP address.

Limitations

Unusable TLDs

Due to a limitation in the Cloudflare API, you can not use this integration with any of the following TLD’s:

  • .cf
  • .ga
  • .gq
  • .ml
  • .tk

Record types

This integration can only update A records.

Zones

This integration can only have 1 instance and manage 1 Zone/TLD.

Reconfiguration

This integration must be deleted and re-added to change the Zone and A record selection. You cannot view which records were selected or view the API Token once the integration is configured.