mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 07:46:49 +00:00

* Standardized values in the example configuration Removed what appear to be an actual API key from the example configuration.yaml block. And, replaced with values as described in the [developer docs](https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages) * Standardize example configuration-ecobee * Standardize example configuration-coinbase * Standardize example configuration-google assistant * Standardize example configuration-cloudflare * Standardize example configuration-cloudflare * Standardize example configuration-habitica * Standardize example configuration-ifttt * Standardize example configuration-openalpr * Standardize example configuration-multiple * Standardize example configuration-instapush * Standardize example configuration-llamalab * Standardize example configuration-notify * Standardize example configuration-mailgun * Standardize example configuration-MULTIPLE * Standardize example configuration-rtm * Standardize example configuration-spotcrime * Standardize example configuration-trafikverket * Standardize example configuration-uk transport * Standardize example configuration-wunderground * Standardize example configuration-wsdot * Standardize example configuration-telegram * Standardize example configuration-tts * Standardize example configuration-tts, vultr * Replace email entry * Replace IP address * Place email address
59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
---
|
|
layout: page
|
|
title: "Cloudflare"
|
|
description: "Automatically update your Cloudflare DNS records."
|
|
date: 2018-07-10 20:08
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: cloudflare.png
|
|
ha_category: Network
|
|
featured: false
|
|
ha_release: 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:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
cloudflare:
|
|
email: YOUR_EMAIL_ADDRESS
|
|
api_key: YOUR_GLOBAL_API_KEY
|
|
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](https://www.ipify.org/) to set the public IP address.
|