api access

External API

  1. Home › 
  2. API Access

List of DNS resource records

Allows to retrieve DNS resource records by domain with pagination

Fully qualified domain name FQDN

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

An array of DNS resource records. Common properties for all records are listed below
The DNS record name refers to the domain name associated with a particular DNS record. It is the leftmost part of a DNS record that specifies the host or subdomain to which the record applies. If name refers to the root (apex) domain and host/subdomain part should be empty then value @ is used.
DNS (Domain Name System) record types are specific entries within a DNS zone file that help to map domain names to corresponding IP addresses or provide other types of information.
DNS TTL stands for Time to Live (seconds). It is a setting in a Domain Name System (DNS) record that determines how long a DNS resolver is supposed to cache the information before it should be refreshed from the authoritative DNS servers. It is specified in seconds and helps in managing DNS caching and ensuring efficient DNS resolution across the internet. Minimum value: 60. Maximum value: 32767

A - 32-bit IPv4 address, usually used to specify the correspondence between hostname and IP address.

IPv4 address

AAAA - 128-bit IPv6 address, used to specify the correspondence between hostname and IP address.

IPv6 address

CNAME is a type of resource record in the Domain Name System (DNS) that is used to indicate that a given name is an alias for another name (canonical domain).

A CNAME record must always point to another domain name and never to an IP address.

All information about other domain alias records, including MX records and others, will be obtained from the canonical domain. The CNAME record must be the only record for a given domain name and, according to the specification, CNAME is not allowed to be used for the root domain of a zone.

Fully qualified domain name. The value may contain @ to refer to the root domain name. For example, for the domain example.com, the CNAME target www.@ would result in a value displayed as www.example.com

MX (mail service) is a type of Domain Name System (DNS) resource record that indicates the mail servers responsible for handling mail for a given domain name, as well as the priority of the servers if there is more than one.

The priority field specifies the order in which mail servers should be used to deliver mail to a particular domain. Mail servers with lower priority values are tried first, and if they are unavailable or unreachable, servers with higher priority values are tried.
The exchange field specifies the domain name of the mail server that is responsible for accepting e-mail messages on behalf of the domain.

TXT (text record) is a type of Domain Name System (DNS) resource record that is used to specify additional information about a domain, often this data is intended not only for software but also for people.

For example, this record is used to specify SPF (Sender Policy Framework) policies for mail servers.

Refers to the text data associated with a record. This text data can contain any arbitrary information that the domain owner wants to include in the DNS record. TXT records are typically used for a variety of purposes such as domain validation for email services, SPF records for email authentication, DKIM records for email security, and other types of textual information needed to configure or validate a domain.

SRV (Service Record Value) is often used to discover services associated with a domain. This record contains the hostname, port, and other data necessary to discover the service.

Specifies the symbolic name of the desired service for which the entry is being created. The value must begin with an underscore _. This field identifies the specific service or protocol that the SRV record defines. Examples of common service names used in SRV records include "_sip" for SIP (Session Initiation Protocol) services, "_ldap" for LDAP (Lightweight Directory Access Protocol) services, "_xmpp" for XMPP (Extensible Messaging and Presence Protocol) services, and so on.
The field specifies the transport protocol used for the service defined in the record. The value must begin with an underscore _, such as _tcp. This field indicates whether the service uses TCP (Transmission Control Protocol), UDP (User Datagram Protocol), or another transport protocol for communication.
Specifies the priority of the target host in the SRV entry. It specifies the order in which target hosts should be used when multiple hosts are available for a particular service
Used in conjunction with the priority field to provide a way to load balance between multiple SRV records with the same priority. The "weight" field indicates the relative weight of an SRV record compared to other SRV records with the same priority
Specifies the TCP or UDP port number on which the service specified in the entry is available.
Specifies the domain name of the target host providing the service. This field contains the hostname of the server host that offers the service specified in the SRV record

CAA allows the owner of a DNS domain name to specify one or more Certificate Authorities (CAs) authorized to issue certificates for the domain.

Specifies the domain name of the CA (Certificate Authority) that is authorized to issue SSL/TLS certificates for the corresponding domain.
Specifies the type of property associated with the CAA record
issue defines certificate authorities authorized to issue certificates for a domain
issuewild defines certificate authorities authorized to issue universal certificates for a domain
iodef specifies the email address to which certificate authorities should report policy violations
issuemail non-standard extension used to authorize a certificate authority to issue S/MIME (email) certificates for a domain
issuevmc non-standard extension used to authorize a certificate authority to issue VMC (Verified Mark Certificates), which enable displaying a brand logo in email clients that support BIMI (Brand Indicators for Message Identification)

NS - this type of record indicates the authoritative DNS server for the domain name (this server contains up-to-date DNS records). Often a domain is delegated to several DNS servers and has several NS records that point to primary and backup servers.

Regery prohibits the creation of an NS record for the root domain of a zone. To do this, use the DNS Provider change tool.

Refers to the nameserver domain name

ALIAS - like a CNAME record associates an alias name with another domain name (canonical domain).

This type of record is not directly described in the DNS specification and, unlike CNAME, allows you to specify additional records of other types. For example, if a AAAA record is requested by a DNS client but does not exist for an alias domain, it will be recursively requested from the canonical domain. If the AAAA record exists, its value will be returned without recursive querying.

Fully qualified domain name. The value may contain @ to refer to the root (apex) domain name. For example, for apex example.com, the target www.@ will result in a value displayed as www.example.com

HTTP ENDPOINT
GET /v1/domains/:domain/records?offset=:offset&limit=:limit
EXAMPLE REQUEST: GET /v1/domains/example.com/records?offset=50
EXAMPLE RESPONSE: HTTP 200 OK
{
    "records": [
        {
           "type": "A",
           "name": "@",
           "address": "192.168.0.1",
           "ttl": 3600
			},
        {
           "type": "CNAME",
           "name": "www",
           "target": "@",
           "ttl": 3600
        }
    ]
}