For the complete documentation index, see llms.txt. This page is also available as Markdown.

Name.com

NOTE: This provider is currently has no maintainer. We are looking for a volunteer. If this provider breaks it may be disabled or removed if it can not be easily fixed.

Configuration

To use this provider, add an entry to creds.json with TYPE set to NAMEDOTCOM along with your name.com API username and access token:

Example:

creds.json
{
  "name.com": {
    "TYPE": "NAMEDOTCOM",
    "apikey": "yourApiKeyFromName.com",
    "apiuser": "yourUsername"
  }
}

There is another key name apiurl but it is optional and defaults to the correct value. If you want to use the test environment ("OT&E"), then add this:

"apiurl": "https://api.dev.name.com",

For compatibility with existing configurations, apiurl also accepts a hostname without https://.

Metadata

This provider does not recognize any special metadata fields unique to name.com.

Usage

An example dnsconfig.js configuration with NAMEDOTCOM as the registrar and DNS service provider:

An example dnsconfig.js configuration with NAMEDOTCOM as the registrar and DNS only, DNS hosted elsewhere:

NOTE: name.com does not allow control over the NS records of your zones via the api. It is not recommended to use name.com's dns provider unless it is your only dns host.

Activation

In order to activate API functionality on your Name.com account, you must apply to the API program. The application form is located here. It usually takes a few days to get a response. After you are accepted, you should receive your API token via email.

Tips and error messages

invalid character '<'

This error means an invalid URL is being used to reach the API endpoint. It usually means a setting is api.name.com/api when api.name.com is correct (i.e. remove the /api).

In creds.json, remove the extra /api from apiurl, or omit apiurl to use the default.

TODO(tlim): Improve the error message. (Volunteer needed!)

Feature Summary

Last updated