dnscontrol/docs/_providers/ns1.md
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

39 lines
636 B
Markdown

---
name: NS1
title: NS1 Provider
layout: default
jsId: NS1
---
# NS1 Provider
NS1 provides a dns provider implementation for ns1 dns.
## Configuration
In your providers config json file you must provide your ns1 api key:
{% highlight json %}
{
"ns1":{
"api_token": "your-ns1-token"
}
}
{% endhighlight %}
## Metadata
This provider does not recognize any special metadata fields unique to ns1.
## Usage
Example javascript:
{% highlight js %}
var REG_NONE = NewRegistrar('none', 'NONE')
var NS1 = NewDnsProvider("ns1", "NS1");
D("example.tld", REG_NONE, DnsProvider(NS1),
A("test","1.2.3.4")
);
{% endhighlight %}