Bulk create domains
Login to the portal and go to Account > Bulk jobs > Create domains
- 1
- Scroll down and download the CSV example file, the template file will be used to request the creates through our portal.
- 2
- Once the download is completed, open the template file. Once opened, you'll notice example.com is pre-filled in the CSV file to serve as an example on how to submit the required data for a create. The domainName, registrant, privacyprotect, period, autoRenew, ns, admin, billing & tech fields are required for a create.
Important
Take note that contacts you provide in the CSV file have to be existent in your Realtime Register account. In case the contacts submitted in the CSV are non-existent in your account, the bulk create request will run into an error indicating the relevant contact(s) cannot be found and creates will not be requested at all.
- 3
- We'll go over the available fields in the CSV template and what information in what format needs to be submitted where one by one. Keep in mind that not all fields require input.
Important
Required fields
The domainName, registrant, privacyprotect, period, autoRenew, ns, admin, billing & tech fields are required for a create. You can submit only these fields as our bulk tool provides the option to add/update the data provided in the CSV once the CSV has been uploaded into the bulk tool.
Multiple values
Multiple fields
To use, add a number to the column name and increment for multiple values. For example, you can have columns ns1, ns2 etc.
Field seperator
Use one of the following field separators to indicate multiple values in a field: | , \n
domainName
Submit the domain to be created here in the format domain.tld, in the template CSV-file an example domain is provided; 'example.com'
registrant
Submit the registrant contacthandle here. In the template CSV-file an example contacthandle is provided; 'handle-001'
privacyProtect
Submit the privacy protect setting here. In case you opt for privacyProtect true for gTLD's, this will skip the step in which the registrant has to confirm her/his contactdetails before the domain will receive an OK status once the create has been completed. In case you opt out for privacyProtect, domains will be created but will receive a pendingValidation status upon completion of the create. The pendingValidation status will remain active untill the registrant has completed contact validation. Keep in mind not all TLD's support privacyProtect, for more information on whether a TLD supports privacy protect or not, check our TLD-metadata
period
Define the create period with which you wish to create a domain. gTLD's default to a create period of 12 months if left undefined, ccTLD's will default to the shortest create period if left undefined in a bulk create job. For more information of the supported create periods per TLD, check our TLD-metadata
LanguageCode
In case you're creating a IDN-domain, you can specify the language code here. For more information on the supported language codes per TLD, you can check our TLD-metadata
autoRenew
Submit the autorenew setting you wish to set after completing the create here. For autorenew ON, submit true. For autorenew OFF, submit false
ns
Submit the nameservers you wish to set once the create is completed. In case you leave the ns field empty, no nameservers will be set for the domain once the create is completed and the domain will receive an Inactive status upon completion of the create. Keep in mind that not all registries allow for domains to be created without nameservers. For more information on the minimum/maximum nameserver requirements for the TLD's we offer, check our TLD-metadata
skipValidation
If active for your Realtime Register account, choose whether to skip validation or not
template
Submit the DNS-template to use in order to use our free to use nameservers once the create has been done.
templateLink
Choose the link or unlinked setting when using a DNS-template for the create. Linked means the domain's zone is dynamic with the DNS-template, changes made to the DNS-template will be processed to the domain's zone upon updating the DNS-template. Unlinked means the domain's zone is static, changes made to a DNS-template will not be processed to the domain's zone when a DNS-template is updated. To link the DNS template upon completion of the create, submit true. To not link a template on completion of the create, submit false
admin
Submit the admin contacthandle here
billing
Submit the billing contacthandle here
tech
Submit the tech contacthandle here
billableProduct
Submit the billable product here if applicable
billableAction
Submit the billable action here if applicable
billableQuantity
Submit the billable quantity here if applicable
dnssecProtocol
Submit the dnssecProtocol here in case you wish to create in a domain with DNSSEC.
dnssecFlags
Submit the dnssecFlag here
dnssecAlgorithm
Submit the dnssec algorithem here
dnssecPublicKey
Submit the dnssecPublicKey here. You can select the option to keep existing Publickey's in the bulk job overview page once you've uploaded the CSV.
- 4
- Once you've submitted all the values you wish to define, your template file should look similar like the example below;
- 5
- Name the bulk create job, upload the CSV template in the bulk create tool and click next
- 6
- On the bulk create overview page, you can map the data that was provided in the CSV before creating the bulk create job. Map the create data as required and click Create job to create the bulk create job
Important
In case you have defined multiple values for fields in your CSV, you need to map the multiple values according to the used method in your CSV, otherwise the bulk create tool will not recognize the values. Below you'll find an example on how to map multiple fields (ns1, ns2 etc.) and how to map a field separator ( | , \n )
Using multiple fields
When using multiple fields, you need to map the multiple fields in order for the bulk create tool to recognize the multiple fields in the CSV you've uploaded. In the example below, two nameserver fields were provided in the CSV file and mapped to be recognized as ns1 and ns2.
Using a field separator
Select the fields separator used in your CSV. In the example below, a pipe was used to separate the nameser values in the nameserver field of the CSV and mapped to ns1.yoursrs.com & ns2.yoursrs.com
- 7
- On the job detail page, an overview of all the jobs is available and changes can still be made. In case all the data is mapped correctly, you can run all tasks. In case you wish to run a few separate tasks prior to running all tasks, you can make a selection of tasks you wish to run and run them first instead of running all tasks in one go in your first attempt. An option to delete tasks is available as well
- 8
- Once the tasks have completed/failed, they will be detailed on the job detail overview. By clicking on the completed/failed tiles, you'll be able to check the detail overview of the tasks that have completed/failed
Important
In case you run into any failed tasks, just click the failed task tile and you can edit any failed creates to correct the errors (error information is displayed on screen) and retry the failed tasks.
- 9
- You've now successfully ran a bulk create request in our portal. In case you run into any errors you're not able to resolve yourself, be sure to contact our support department, provide the domain(s) you're having issues with and we'll provide assistance to complete creates that have failed