Domain Queue

One of the easiest options for adding domains is to use the Domain Queue, which allows you to supply a list of domains and let DomainMOD take care of the rest (and in some cases you don't even need to supply the list of domains, it will be automatically retrieved from your registrar account).

This option uses your domain registrar's API to retrieve information required to add domains, so unfortunately it only works if your registrar has an API and support for it has been built into DomainMOD. Before using this option make sure your API credentials have been saved with your registrar account.

Supported Registrars

The following registrars are currently supported by the Domain Queue:

Above.com, Cloudflare, DNSimple, DreamHost, Dynadot, eNom, Fabulous, Freenom (Reseller Accounts Only), Gandi, GoDaddy, Hostinger, Internet.bs, Name.com, NameBright, Namecheap, NameSilo, OpenSRS, Porkbun, ResellerClub

Usage

Requirement

In order to use the Domain Queue you must first setup the cron job that comes with DomainMOD.

  1. Click on Domains on the main menu.

  2. Click the Add Domains To Queue button on the Domains page.

  3. On the dropdown list, choose the registrar account that you would like to import using the Domain Queue.

  4. If requested, paste in a list of the domains you want to add to the Domain Queue. This is not always required, as some domain registrars will retrieve the list of domains from your account automatically.

  5. Click the Add Domains button.

  6. You will now be taken to the Domain Queue page, where you can see the status of your domain imports. You can also access the Domain Queue by clicking on Queue on the main menu (this menu option is only available when you have domains being processed in the queue).

  7. Once all of your imports have completed you can click the Clear Completed button in order to clear the queue.

API Notes

This section contains various notes and things to watch out for when using the domain registrar APIs.

Cloudflare

A Cloudflare registrar account uses the following fields:

Username: your Cloudflare account email address. This is required if you use a Global API Key. If you use an API Token it can be any name for the account.
Account ID: shown on your Cloudflare dashboard.
API Key: either an API Token (recommended) or your Global API Key. An API Token needs read access to Registrar domains, plus Zone Read access so that DomainMOD can retrieve the domains' name servers.

DreamHost

DreamHost does not currently allow the WHOIS privacy status of a domain to be retrieved via their API, so all domains added to the Domain Queue from a DreamHost account will have their WHOIS privacy status set to No by default.

Freenom

Freenom currently only gives API access to reseller accounts.

Gandi

For the API Key, create a personal access token in your Gandi account with read access to your domains. Older Gandi API keys still work.

Gandi does not currently allow the WHOIS privacy status of a domain to be retrieved via their API, so all domains added to the Domain Queue from a Gandi account will have their WHOIS privacy status set to No by default.

GoDaddy

When retrieving your list of domains from GoDaddy, the current limit is 1,000 domains. If you have more than this you should export the full list of domains from GoDaddy and paste it into the Domains to add field when adding domains via the Domain Queue.

GoDaddy only gives API access to accounts it considers eligible, and has at times limited it to accounts with at least 10 domains or a Discount Domain Club membership. If GoDaddy refuses your account's API requests, domains added to the Domain Queue from it will stay at "Pending".

Hostinger

For the API Key, create an API token in your Hostinger dashboard (Dev tools -> API -> API tokens). Hostinger API tokens have full access to your Hostinger account, so consider giving the token an expiry date.

Hostinger does not return the Auto Renewal status when retrieving the details of a domain, so all domains imported via the API will have their Auto Renewal status set to No by default.

NameSilo

NameSilo's domains have 6 possible statuses: Active, Expired (grace period), Expired (restore period), Expired (pending delete), Inactive, and Pending Outbound Transfer

When retrieving your list of domains via the API, Inactive domains are not returned.

When retrieving the details of a specific domain via the API, Inactive and Expired (pending delete) domains will not return any data.

Porkbun

When retrieving your list of domains from Porkbun, the current limit is 1,000 domains. If you have more than this you should export the full list of domains from Porkbun and paste it into the Domains to add field when adding domains via the Domain Queue.

ResellerClub

ResellerClub does not allow users to retrieve a list of their domains via the API, nor do they return the Auto Renewal status when retrieving the details of a domain. All domains imported via the API will have their Auto Renewal status set to No by default.

Example

Below is an example of how to use the Domain Queue to import the domains from a Namecheap account:

Create a Domain Registrar asset, ensuring that you've selected Namecheap on the API Support dropdown list.

Domain Registrar


Create an IP Address asset, ensuring that you enter the public IP address of the server that DomainMOD is running on.

IP Address


Create a Domain Registrar Account asset, ensuring that you've entered your account username and API Key, and that you've selected the IP address that you created in the previous step.

Domain Registrar Account


On your Namecheap account, go to Profile -> Tools to view the status of your API access. Next, click on Manage to view your whitelisted IP addresses.

API Access #1


If your API Access was not enabled in the previous step, you can enable it here.

To the right of the Whitelisted IPs section, click on Edit to view your whitelisted IP addresses.

API Access #2


On the Whitelisted IPs page, ensure that your public IP address is listed.

Whitelisted

And that's it, your Namecheap API connection should now be set up!

With your API connection up and running, it's time to import your domains using the Domain Queue.