lego/docs/content/dns/zz_gen_namecheap.md
2022-06-17 00:25:42 +02:00

2.2 KiB

title date draft slug dnsprovider
Namecheap 2019-03-03T16:39:46+01:00 false namecheap
since code url
v0.3.0 namecheap https://www.namecheap.com

Configuration for Namecheap.

To enable API access on the Namecheap production environment, some opaque requirements must be met. More information in the section Enabling API Access of the Namecheap documentation. (2020-08: Account balance of $50+, 20+ domains in your account, or purchases totaling $50+ within the last 2 years.)

  • Code: namecheap
  • Since: v0.3.0

Here is an example bash command using the Namecheap provider:

NAMECHEAP_API_USER=user \
NAMECHEAP_API_KEY=key \
lego --email you@example.com --dns namecheap --domains my.example.org run

Credentials

Environment Variable Name Description
NAMECHEAP_API_KEY API key
NAMECHEAP_API_USER API user

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 Name Description
NAMECHEAP_HTTP_TIMEOUT API request timeout
NAMECHEAP_POLLING_INTERVAL Time between DNS propagation check
NAMECHEAP_PROPAGATION_TIMEOUT Maximum waiting time for DNS propagation
NAMECHEAP_SANDBOX Activate the sandbox (boolean)
NAMECHEAP_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. More information [here]({{< ref "dns#configuration-and-credentials" >}}).

More information