2019-03-08 18:47:06 +00:00
---
title: "Namecheap"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: namecheap
---
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namecheap/namecheap.toml -->
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
2019-04-17 19:32:38 +00:00
Since: v0.3.0
2019-03-08 18:47:06 +00:00
Configuration for [Namecheap ](https://www.namecheap.com ).
2020-08-09 20:10:02 +00:00
**To enable API access on the Namecheap production environment, some opaque requirements must be met.** More information in the section [Enabling API Access ](https://www.namecheap.com/support/api/intro/ ) of the Namecheap documentation. (2020-08: Account balance of $50+, 20+ domains in your account, or purchases totaling $50+ within the last 2 years.)
2019-03-08 18:47:06 +00:00
<!-- more -->
- Code: `namecheap`
2020-01-12 15:51:14 +00:00
Here is an example bash command using the Namecheap provider:
```bash
NAMECHEAP_API_USER=user \
NAMECHEAP_API_KEY=key \
2020-11-27 19:40:44 +00:00
lego --email myemail@example.com --dns namecheap --domains my.example.org run
2020-01-12 15:51:14 +00:00
```
2019-03-08 18:47:06 +00:00
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `NAMECHEAP_API_KEY` | API key |
| `NAMECHEAP_API_USER` | API user |
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.
More information [here ](/lego/dns/#configuration-and-credentials ).
2019-03-08 18:47:06 +00:00
## 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 |
2020-01-12 15:51:14 +00:00
| `NAMECHEAP_SANDBOX` | Activate the sandbox (boolean) |
2019-03-08 18:47:06 +00:00
| `NAMECHEAP_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.
More information [here ](/lego/dns/#configuration-and-credentials ).
2019-03-08 18:47:06 +00:00
## More information
- [API documentation ](https://www.namecheap.com/support/api/methods.aspx )
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namecheap/namecheap.toml -->
<!-- THIS DOCUMENTATION IS AUTO - GENERATED. PLEASE DO NOT EDIT. -->
