2019-03-08 18:47:06 +00:00
|
|
|
---
|
|
|
|
|
title: "Gandi Live DNS (v5)"
|
|
|
|
|
date: 2019-03-03T16:39:46+01:00
|
|
|
|
|
draft: false
|
|
|
|
|
slug: gandiv5
|
2022-06-16 22:25:42 +00:00
|
|
|
dnsprovider:
|
|
|
|
|
since: "v0.5.0"
|
|
|
|
|
code: "gandiv5"
|
|
|
|
|
url: "https://www.gandi.net"
|
2019-03-08 18:47:06 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
|
<!-- providers/dns/gandiv5/gandiv5.toml -->
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Configuration for [Gandi Live DNS (v5)](https://www.gandi.net).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--more-->
|
|
|
|
|
|
|
|
|
|
- Code: `gandiv5`
|
2022-06-16 22:25:42 +00:00
|
|
|
- Since: v0.5.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 Gandi Live DNS (v5) provider:
|
|
|
|
|
|
|
|
|
|
```bash
|
2023-09-20 21:30:21 +00:00
|
|
|
GANDIV5_PERSONAL_ACCESS_TOKEN=abcdefghijklmnopqrstuvwx \
|
2022-06-16 22:25:42 +00:00
|
|
|
lego --email you@example.com --dns gandiv5 --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 |
|
|
|
|
|
|-----------------------|-------------|
|
2023-09-20 21:30:21 +00:00
|
|
|
| `GANDIV5_API_KEY` | API key (Deprecated) |
|
|
|
|
|
| `GANDIV5_PERSONAL_ACCESS_TOKEN` | Personal Access Token |
|
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.
|
2024-08-14 21:55:11 +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 |
|
|
|
|
|
|--------------------------------|-------------|
|
|
|
|
|
| `GANDIV5_HTTP_TIMEOUT` | API request timeout |
|
|
|
|
|
| `GANDIV5_POLLING_INTERVAL` | Time between DNS propagation check |
|
|
|
|
|
| `GANDIV5_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
|
|
|
|
|
| `GANDIV5_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.
|
2024-08-14 21:55:11 +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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## More information
|
|
|
|
|
|
2020-11-27 19:40:44 +00:00
|
|
|
- [API documentation](https://api.gandi.net/docs/livedns/)
|
2019-03-08 18:47:06 +00:00
|
|
|
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
|
<!-- providers/dns/gandiv5/gandiv5.toml -->
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
