2017-03-19 09:58:47 +08:00
|
|
|
---
|
2017-10-11 20:33:17 +08:00
|
|
|
name: DNSimple
|
|
|
|
title: DNSimple Provider
|
2017-03-19 09:58:47 +08:00
|
|
|
layout: default
|
|
|
|
jsId: DNSIMPLE
|
|
|
|
---
|
2017-10-11 20:33:17 +08:00
|
|
|
# DNSimple Provider
|
2017-03-19 09:58:47 +08:00
|
|
|
## Configuration
|
2022-05-09 02:41:33 +08:00
|
|
|
|
2022-07-22 21:36:28 +08:00
|
|
|
To use this provider, add an entry to `creds.json` with `TYPE` set to `DNSIMPLE`
|
2022-05-09 02:41:33 +08:00
|
|
|
along with a DNSimple account access token.
|
|
|
|
|
2022-07-22 21:36:28 +08:00
|
|
|
You can also set the `baseurl` to use [DNSimple's free sandbox](https://developer.dnsimple.com/sandbox/) for testing.
|
|
|
|
|
|
|
|
Examples:
|
2017-03-19 09:58:47 +08:00
|
|
|
|
2022-02-18 01:22:31 +08:00
|
|
|
```json
|
2017-03-19 09:58:47 +08:00
|
|
|
{
|
2017-10-11 20:33:52 +08:00
|
|
|
"dnsimple": {
|
2022-05-09 02:41:33 +08:00
|
|
|
"TYPE": "DNSIMPLE",
|
2017-03-19 09:58:47 +08:00
|
|
|
"token": "your-dnsimple-account-access-token"
|
2022-07-22 21:36:28 +08:00
|
|
|
},
|
|
|
|
"dnsimple_sandbox": {
|
|
|
|
"TYPE": "DNSIMPLE",
|
|
|
|
"baseurl": "https://api.sandbox.dnsimple.com",
|
|
|
|
"token": "your-sandbox-account-access-token"
|
2017-03-19 09:58:47 +08:00
|
|
|
}
|
|
|
|
}
|
2022-02-18 01:22:31 +08:00
|
|
|
```
|
2017-03-19 09:58:47 +08:00
|
|
|
|
|
|
|
## Metadata
|
|
|
|
This provider does not recognize any special metadata fields unique to DNSimple.
|
|
|
|
|
|
|
|
## Usage
|
2022-05-09 02:41:33 +08:00
|
|
|
An example `dnsconfig.js` configuration:
|
2017-03-19 09:58:47 +08:00
|
|
|
|
2022-02-18 01:22:31 +08:00
|
|
|
```js
|
2022-05-09 02:41:33 +08:00
|
|
|
var REG_DNSIMPLE = NewRegistrar("dnsimple");
|
|
|
|
var DSP_DNSIMPLE = NewDnsProvider("dnsimple");
|
2017-03-19 09:58:47 +08:00
|
|
|
|
2022-05-09 02:41:33 +08:00
|
|
|
D("example.tld", REG_DNSIMPLE, DnsProvider(DSP_DNSIMPLE),
|
|
|
|
A("test", "1.2.3.4")
|
2017-03-19 09:58:47 +08:00
|
|
|
);
|
2022-02-18 01:22:31 +08:00
|
|
|
```
|
2017-03-19 09:58:47 +08:00
|
|
|
|
|
|
|
## Activation
|
2022-02-18 01:22:31 +08:00
|
|
|
DNSControl depends on a DNSimple account access token.
|
2022-07-09 13:14:04 +08:00
|
|
|
|
|
|
|
## Caveats
|
|
|
|
|
|
|
|
### CAA
|
|
|
|
|
|
|
|
As of July 2022, the DNSimple DNS does not accept spaces in CAA records. Putting spaces in the record will result in a 400 Validation Failed error.
|
|
|
|
|
|
|
|
```
|
|
|
|
0 issue "letsencrypt.org; validationmethods=dns-01; accounturi=https://acme-v02.api.letsencrypt.org/acme/acct/1234"
|
|
|
|
```
|
|
|
|
|
|
|
|
Removing the spaces will work.
|
|
|
|
```
|
|
|
|
0 issue "letsencrypt.org;validationmethods=dns-01;accounturi=https://acme-v02.api.letsencrypt.org/acme/acct/1234"
|
|
|
|
```
|
|
|
|
|