2019-03-08 18:47:06 +00:00
---
title: "PowerDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: pdns
2022-06-16 22:25:42 +00:00
dnsprovider:
since: "v0.4.0"
code: "pdns"
url: "https://www.powerdns.com/"
2019-03-08 18:47:06 +00:00
---
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/pdns/pdns.toml -->
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
Configuration for [PowerDNS ](https://www.powerdns.com/ ).
<!-- more -->
- Code: `pdns`
2022-06-16 22:25:42 +00:00
- Since: v0.4.0
2019-03-08 18:47:06 +00:00
2020-11-27 19:40:44 +00:00
Here is an example bash command using the PowerDNS provider:
```bash
PDNS_API_URL=http://pdns-server:80/ \
PDNS_API_KEY=xxxx \
2022-06-16 22:25:42 +00:00
lego --email you@example.com --dns pdns --domains my.example.org run
2020-11-27 19:40:44 +00:00
```
2019-03-08 18:47:06 +00:00
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `PDNS_API_KEY` | API key |
2020-09-29 22:27:08 +00:00
| `PDNS_API_URL` | API URL |
2019-03-08 18:47:06 +00:00
2019-03-18 16:42:54 +00:00
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
2022-06-16 22:25:42 +00:00
More information [here ]({{< ref "dns#configuration-and-credentials" >}} ).
2019-03-18 16:42:54 +00:00
2019-03-08 18:47:06 +00:00
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
2024-01-27 22:23:10 +00:00
| `PDNS_API_VERSION` | Skip API version autodetection and use the provided version number. |
2019-03-08 18:47:06 +00:00
| `PDNS_HTTP_TIMEOUT` | API request timeout |
| `PDNS_POLLING_INTERVAL` | Time between DNS propagation check |
| `PDNS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
2021-03-17 08:53:38 +00:00
| `PDNS_SERVER_NAME` | Name of the server in the URL, 'localhost' by default |
2019-03-08 18:47:06 +00:00
| `PDNS_TTL` | The TTL of the TXT record used for the DNS challenge |
2019-03-18 16:42:54 +00:00
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
2022-06-16 22:25:42 +00:00
More information [here ]({{< ref "dns#configuration-and-credentials" >}} ).
2019-03-18 16:42:54 +00:00
2019-03-08 18:47:06 +00:00
## Information
Tested and confirmed to work with PowerDNS authoritative server 3.4.8 and 4.0.1. Refer to [PowerDNS documentation ](https://doc.powerdns.com/md/httpapi/README/ ) instructions on how to enable the built-in API interface.
PowerDNS Notes:
- PowerDNS API does not currently support SSL, therefore you should take care to ensure that traffic between lego and the PowerDNS API is over a trusted network, VPN etc.
- In order to have the SOA serial automatically increment each time the `_acme-challenge` record is added/modified via the API, set `SOA-EDIT-API` to `INCEPTION-INCREMENT` for the zone in the `domainmetadata` table
2024-01-27 22:23:10 +00:00
- Some PowerDNS servers doesn't have root API endpoints enabled and API version autodetection will not work. In that case version number can be defined using `PDNS_API_VERSION` .
2019-03-08 18:47:06 +00:00
## More information
- [API documentation ](https://doc.powerdns.com/md/httpapi/README/ )
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/pdns/pdns.toml -->
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
