Back to Lego

Brandit (deprecated)

docs/content/dns/zz_gen_brandit.md

4.35.21.9 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/brandit/brandit.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Brandit has been acquired by Abion. Abion has a different API.

If you are a Brandit/Albion user, you can try the PR https://github.com/go-acme/lego/pull/2112.

<!--more-->
  • Code: brandit
  • Since: v4.11.0

Here is an example bash command using the Brandit (deprecated) provider:

bash
BRANDIT_API_KEY=xxxxxxxxxxxxxxxxxxxxx \
BRANDIT_API_USERNAME=yyyyyyyyyyyyyyyyyyyy \
lego --dns brandit -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
BRANDIT_API_KEYThe API key
BRANDIT_API_USERNAMEThe API username

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
BRANDIT_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
BRANDIT_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
BRANDIT_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 600)
BRANDIT_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 600)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/brandit/brandit.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->