Domains
Security
Tools
Company
USD
EN
api access

External API

  1. Home › 
  2. API Access

REGERY API

OverviewIntroductionAuthenticationTest modeDomains zonesStates/Regions
AccountGet balance
Messages queueReadAcknowledge
DomainsCheckListInfoRegistrationTransferUpdateRenewRestoreBulk checkPremium prices
ContactsSaveRead
HostsCreateReadUpdateDelete
DNSAddReadDelete
DocumentsUpload

Domain registration

Domain name registration is the process of reserving a unique name on the Internet for a specific period of time, usually one year or more

URL parameters 

•︎ domain string 
Fully qualified domain name FQDN

POST body parameters 

•︎ period number 
Number of years to register a domain. For most domain name zones this value is between 1 year and 10 years
•︎ autoRenew boolean | default = false 
If true, the domain name will be automatically renewed
•︎ nameservers object | default = {"provider": "basic"} 
The name servers that a domain name uses for delegation
•︎ list string[] 
An array of name servers. Most domain name zones require at least two name servers to be specified
•︎ provider enum 
If no list of nameservers is specified, one of the providers is specified. If a list of name servers is specified, the provider should be omitted
basic Regery default nameservers set
blackHole black hole name servers. Such servers always return NXDOMAIN
•︎ contacts object 
During the registration process, you must provide a link to at least the registrant's contact information
•︎ registrant string 
Link to domain name owner contact details
•︎ admin string | default = same as registrant 
Reference to contact details
•︎ tech string | default = same as registrant 
Reference to contact details
•︎ billing string | default = same as registrant 
Reference to contact details
•︎ services enum[] 
For each domain zone additional services can be used to assist in registration. Such services may be combined depending on the rules of a particular domain zone
proxy contact information is not sent to the registry, but instead proxy contacts are sent. This helps to hide domain owner information from the public WHOIS
trustedRegistrant if the domain name zone has special requirements for the domain name owner, this service will help fulfill the registry's requirements by providing a trusted contact
trustedAdmin if a domain name zone has special requirements for a domain name administrator contact, this service will help fulfill registry requirements by providing a trusted contact
trustedTech if a domain name zone has specific requirements for a domain name technician contact, this service will help fulfill registry requirements by providing a trusted contact
•︎ disclose boolean | default = false 
Some registries have the ability to hide/disclose contact information from publicly available WHOIS resources. This option can be controlled by this flag if the registry supports it
•︎ idnTag string 
Required to register IDN domain names. An IDN domain refers to an internationalized domain name. These domains support characters other than ASCII, which allows domain names to be registered in languages other than English, such as Arabic, Chinese, or Cyrillic characters

Response parameters 

•︎ pending boolean 
Indicates whether the request has been completed or queued for processing
HTTP ENDPOINT
POST /v1/domains/:domain
EXAMPLE REQUEST: POST /v1/domains/example.com
{
    "period": 1,
    "nameservers": {
        "list": ["ns1.nameserver.com", "ns2.nameserver.com"]
    },
    "contacts": {
        "registrant": "ABCDEFGHIJ"
    }
}
EXAMPLE RESPONSE: HTTP 200 OK
{
    "pending": false
}