lego/docs/content/dns/zz_gen_gandi.md

68 lines
1.7 KiB
Markdown
Raw Normal View History

---
title: "Gandi"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: gandi
2022-06-16 22:25:42 +00:00
dnsprovider:
since: "v0.3.0"
code: "gandi"
url: "https://www.gandi.net"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandi/gandi.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Configuration for [Gandi](https://www.gandi.net).
<!--more-->
- Code: `gandi`
2022-06-16 22:25:42 +00:00
- Since: v0.3.0
Here is an example bash command using the Gandi provider:
```bash
GANDI_API_KEY=abcdefghijklmnopqrstuvwx \
2022-06-16 22:25:42 +00:00
lego --email you@example.com --dns gandi --domains my.example.org run
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `GANDI_API_KEY` | API key |
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" %}}).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `GANDI_HTTP_TIMEOUT` | API request timeout |
| `GANDI_POLLING_INTERVAL` | Time between DNS propagation check |
| `GANDI_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `GANDI_TTL` | The TTL of the TXT record used for the DNS challenge |
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" %}}).
## More information
2021-04-25 09:51:37 +00:00
- [API documentation](https://doc.rpc.gandi.net/index.html)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandi/gandi.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->