github.com/StackExchange/dnscontrol/v4@v4.11.0/documentation/provider/dnsimple.md (about)

     1  ## Configuration
     2  
     3  To use this provider, add an entry to `creds.json` with `TYPE` set to `DNSIMPLE`
     4  along with a DNSimple account access token.
     5  
     6  You can also set the `baseurl` to use [DNSimple's free sandbox](https://developer.dnsimple.com/sandbox/) for testing.
     7  
     8  Examples:
     9  
    10  {% code title="creds.json" %}
    11  ```json
    12  {
    13    "dnsimple": {
    14      "TYPE": "DNSIMPLE",
    15      "token": "your-dnsimple-account-access-token"
    16    },
    17    "dnsimple_sandbox": {
    18      "TYPE": "DNSIMPLE",
    19      "baseurl": "https://api.sandbox.dnsimple.com",
    20      "token": "your-sandbox-account-access-token"
    21    }
    22  }
    23  ```
    24  {% endcode %}
    25  
    26  ## Metadata
    27  
    28  This provider does not recognize any special metadata fields unique to DNSimple.
    29  
    30  ## Usage
    31  
    32  An example configuration:
    33  
    34  {% code title="dnsconfig.js" %}
    35  ```javascript
    36  var REG_DNSIMPLE = NewRegistrar("dnsimple");
    37  var DSP_DNSIMPLE = NewDnsProvider("dnsimple");
    38  
    39  D("example.com", REG_DNSIMPLE, DnsProvider(DSP_DNSIMPLE),
    40      A("test", "1.2.3.4"),
    41  END);
    42  ```
    43  {% endcode %}
    44  
    45  ## Activation
    46  
    47  DNSControl depends on a DNSimple account access token.
    48  
    49  ## Caveats
    50  
    51  ### TXT record length
    52  
    53  The DNSimple API supports TXT records of up to 1000 "characters" (assumed to
    54  be octets, per DNS norms, not Unicode characters in an encoding).
    55  
    56  See https://support.dnsimple.com/articles/txt-record/
    57  
    58  ## Development
    59  
    60  ### Debugging
    61  
    62  Set `DNSIMPLE_DEBUG_HTTP` environment variable to `1` to dump all API calls made by this provider.