Back to Lego

Namecheap

docs/content/dns/zz_gen_namecheap.md

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

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.)

<!--more-->
  • Code: namecheap
  • Since: v0.3.0

Here is an example bash command using the Namecheap provider:

bash
NAMECHEAP_API_USER=user \
NAMECHEAP_API_KEY=key \
lego --dns namecheap -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
NAMECHEAP_API_KEYAPI key
NAMECHEAP_API_USERAPI 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 NameDescription
NAMECHEAP_HTTP_TIMEOUTAPI request timeout in seconds (Default: 60)
NAMECHEAP_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 15)
NAMECHEAP_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 3600)
NAMECHEAP_SANDBOXActivate the sandbox (boolean)
NAMECHEAP_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 120)

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/namecheap/namecheap.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->