mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 07:46:49 +00:00
1833c32a2c
* Sets front matter defaults * Removes default front matter from section templates/pages * Removes default front matter from addon pages * Removes default front matter from integration pages * Removes default front matter from posts * Removes default front matter from docs pages * Removes default front matter from other pages * Fixes blog category pages
53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
---
|
|
title: "Cloudflare"
|
|
description: "Automatically update your Cloudflare DNS records."
|
|
logo: cloudflare.png
|
|
ha_category:
|
|
- Network
|
|
ha_release: 0.74
|
|
---
|
|
|
|
With the `cloudflare` integration can you keep your Cloudflare records up to date.
|
|
|
|
The integration will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services.
|
|
|
|
## Setup
|
|
|
|
You will find your global API key in your Cloudflare account settings.
|
|
|
|
## Configuration
|
|
|
|
To use the integration 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.
|