api access

External API

  1. Home › 
  2. API Access

List of domains under management

Allows to retrieve domains list with pagination

The offset refers to the starting point from which the data should be retrieved in the page response. It indicates the number of items that must be skipped from the beginning before the actual data is returned

The parameter specifies the maximum number of elements to be returned per page or response. It controls the size of the subset of data that the API returns for a particular request

Total number of domains available for query

An array of domains under management. Common properties for all records are listed below
Fully qualified domain name FQDN
Current domain expiration date
Final Domain Name Renewal Date. Many domain zones require that the renewal transaction be completed before the actual expiration date
Array of domain statuses
pendingCreate The domain is in the process of registration. A message about registration completion will be added to the queue
If true, the domain name will be automatically renewed
The name servers that a domain name uses for delegation
An array of name servers. Most domain name zones require at least two name servers to be specified
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
During the registration process, you must provide a link to at least the registrant's contact information
Link to domain name owner contact details
Reference to contact details
Reference to contact details
Reference to contact details
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
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

HTTP ENDPOINT
GET v1/domains?offset=:offset&limit=:limit
EXAMPLE REQUEST: GET /v1/domains
EXAMPLE RESPONSE: HTTP 200 OK
{
    "total": 1,
    "domains": [
         {
            "name": "example.com",
            "expiration": "2000-06-15T10:00:00.0000000+00:00",
            "dueDate": "2000-06-15T10:00:00.0000000+00:00",
            "autoRenew": false,
            "nameservers": {
                "provider": null,
                "list": [
                    "ns1.nameservers.net",
                    "ns2.nameservers.net"
                ]
            },
            "contacts": {
                "services": [],
                "registrant": "ABCDEFGHIJ",
                "admin": "ABCDEFGHIJ",
                "tech": "ABCDEFGHIJ",
                "billing": "ABCDEFGHIJ",
                "disclose": false
            }
        }
    ]
}