home-assistant.io/source/_components/cloudflare.markdown
Joakim Sørensen 8ac7b4c329 Documentation for Cloudflare (#5723)
* Initial documentation for Cloudflare

* Corrected typo

* ✏️ Tweaks

* ✏️ Tweaks

* Changed records to be required

* correction about records

* Minor changes

* changed ha_release
2018-07-09 23:39:38 +02:00

1.4 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, featured, ha_release
layout title description date sidebar comments sharing footer logo ha_category featured ha_release
page Cloudflare Automatically update your Cloudflare DNS records. 2018-07-10 20:08 true false true true cloudflare.png Utility false 0.74

With the cloudflare component can you keep your Cloudflare records up to date.

The component will run every hour, but can also be started manually by using the service cloudflare.update_records under services.

{% linkable_title Setup %}

You will find your global API key in your Cloudflare account settings.

{% linkable_title Configuration %}

To use the component in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
cloudflare:
  email: user@example.com
  api_key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41
  zone: example.com
  records:
    - bin
    - www

{% configuration cloudflare %} email: description: The email address for your Cloudflare account. required: true type: string api_key: description: The global API key for your Cloudflare account. required: true type: string zone: description: The DNS zone you want to update. required: true type: string records: description: A list of records you want to update. required: true type: list {% endconfiguration %}

This platform uses the API from ipify.org to set the public IP address.