mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-11-15 20:55:34 +08:00

Patrick G 31bdb65720 Improved consistency of provider documentation (#222 )

- Fixed indentation
- Use same naming scheme for all examples
  (i.e. all caps for provider, REG prefix for registrar)
- Use REG_NONE as registrar when provider does not provide it
- Use example.tld for example domain
- Use 1.2.3.1/24 IP range for examples
- A few spelling fixes

2017-10-11 08:33:52 -04:00

1.3 KiB

Raw Blame History

name	layout	jsId
Namecheap Provider	default	NAMECHEAP

Namecheap Provider

Namecheap only provides a registrar provider implementation.

Configuration

In your providers config json file you must provide your Namecheap api username and key:

{% highlight json %} { "namecheap":{ "apikey": "yourApiKeyFromNameCheap", "apiuser": "yourUsername" } } {% endhighlight %}

You can optionally specify BaseURL to use a different endpoint - typically the sandbox:

{% highlight json %} { "namecheap.com":{ "apikey": "yourApiKeyFromNameCheap", "apiuser": "yourUsername" "BaseURL": "https://api.sandbox.namecheap.com/xml.response" } } {% endhighlight %}

if BaseURL is omitted, the production namecheap url is used.

Metadata

This provider does not recognize any special metadata fields unique to Namecheap.

Usage

Example javascript:

{% highlight js %} var REG_NAMECHEAP = NewRegistrar("namecheap","NAMECHEAP"); var R53 = NewDnsProvider("r53", "ROUTE53");

D("example.tld", REG_NAMECHEAP, DnsProvider(R53), A("test","1.2.3.4") ); {%endhighlight%}

Activation

In order to activate api functionality on your Namecheap account, you must enable it for your account and wait for their review process. More information on enabling API access is located here.

1.3 KiB Raw Blame History