2017-09-13 23:49:15 +08:00
|
|
|
## Configuration
|
|
|
|
|
2022-05-09 02:41:33 +08:00
|
|
|
To use this provider, add an entry to `creds.json` with `TYPE` set to `NS1`
|
|
|
|
along with your NS1 api key.
|
|
|
|
|
|
|
|
Example:
|
2017-09-13 23:49:15 +08:00
|
|
|
|
2022-02-18 01:22:31 +08:00
|
|
|
```json
|
2017-09-13 23:49:15 +08:00
|
|
|
{
|
2022-05-09 02:41:33 +08:00
|
|
|
"ns1": {
|
|
|
|
"TYPE": "NS1",
|
2017-09-13 23:49:15 +08:00
|
|
|
"api_token": "your-ns1-token"
|
|
|
|
}
|
|
|
|
}
|
2022-02-18 01:22:31 +08:00
|
|
|
```
|
2017-09-13 23:49:15 +08:00
|
|
|
|
|
|
|
## Metadata
|
2017-10-11 23:54:32 +08:00
|
|
|
This provider does not recognize any special metadata fields unique to NS1.
|
2017-09-13 23:49:15 +08:00
|
|
|
|
|
|
|
## Usage
|
2022-05-09 02:41:33 +08:00
|
|
|
An example `dnsconfig.js` configuration:
|
2017-09-13 23:49:15 +08:00
|
|
|
|
2023-01-20 20:56:20 +08:00
|
|
|
```javascript
|
2022-05-09 02:41:33 +08:00
|
|
|
var REG_NONE = NewRegistrar("none");
|
|
|
|
var DSP_NS1 = NewDnsProvider("ns1");
|
2017-09-13 23:49:15 +08:00
|
|
|
|
2022-05-09 02:41:33 +08:00
|
|
|
D("example.tld", REG_NONE, DnsProvider(DSP_NS1),
|
|
|
|
A("test", "1.2.3.4")
|
2017-09-13 23:49:15 +08:00
|
|
|
);
|
2022-02-18 01:22:31 +08:00
|
|
|
```
|
2017-09-13 23:49:15 +08:00
|
|
|
|