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

     1  {% hint style="info" %}
     2  **NOTE**: This provider is currently has no maintainer. We are looking for
     3  a volunteer. If this provider breaks it may be disabled or removed if
     4  it can not be easily fixed.
     5  {% endhint %}
     6  
     7  ## Configuration
     8  
     9  To use this provider, add an entry to `creds.json` with `TYPE` set to `SOFTLAYER`
    10  along with authentication fields.
    11  Authenticating with SoftLayer requires at least a `username` and `api_key` for authentication. It can also optionally take a `timeout` and `endpoint_url` parameter however these are optional and will use standard defaults if not provided.
    12  
    13  Example:
    14  
    15  {% code title="creds.json" %}
    16  ```json
    17  {
    18    "softlayer": {
    19      "TYPE": "SOFTLAYER",
    20      "api_key": "mysecretapikey",
    21      "username": "myusername"
    22    }
    23  }
    24  ```
    25  {% endcode %}
    26  
    27  To maintain compatibility with existing softlayer CLI services these can also be provided by the `SL_USERNAME` and `SL_API_KEY` environment variables or specified in the `~/.softlayer`, but this is discouraged. More information about these methods can be found at [the softlayer-go library documentation](https://github.com/softlayer/softlayer-go#sessions).
    28  
    29  ## Usage
    30  
    31  An example configuration:
    32  
    33  {% code title="dnsconfig.js" %}
    34  ```javascript
    35  var REG_NONE = NewRegistrar("none");
    36  var DSP_SOFTLAYER = NewDnsProvider("softlayer");
    37  
    38  D("example.com", REG_NONE, DnsProvider(DSP_SOFTLAYER),
    39      A("test", "1.2.3.4"),
    40  END);
    41  ```
    42  {% endcode %}
    43  
    44  ## Metadata
    45  This provider does not recognize any special metadata fields unique to SoftLayer dns.
    46  For compatibility with the pre-generated NAMESERVER fields it's recommended to set the NS TTL to 86400 such as:
    47  
    48  {% code title="dnsconfig.js" %}
    49  ```javascript
    50  var REG_NONE = NewRegistrar("none");
    51  var DSP_SOFTLAYER = NewDnsProvider("softlayer");
    52  
    53  D("example.com", REG_NONE, DnsProvider(SOFTLAYER),
    54      NAMESERVER_TTL(86400),
    55  
    56      A("test", "1.2.3.4"),
    57  END);
    58  ```
    59  {% endcode %}