Page tree
Skip to end of metadata
Go to start of metadata

API Essentials

API Key Generation

Autoscaling

Backups

Credit

DNS

Firewall Rules

Flex Cloud VM Control

Getting Started with Superb Flex Cloud

IP Addresses

Logs

Network Interfaces

Recipes

SSH Keys

Templates

Test Route

Troubleshooting API Issues

Viewing Activity Logs

Virtual Server Operating Systems

Virtual Servers

VS Disks

GET /dns_zones/:dns_zone_id/records

Returns a list of zone records

Sections:

Response Parameters

 

name – DNS zone name.

created_at – the date when the DNS zone was created in the [YYYY][MM][DD]T[hh][mm][ss]Z format

updated_at - the date when the DNS zone was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

id – DNS zone ID

user_id – the ID of a user who has created a DNS zone

The array of DNS records sorted by type with their details:

MX – the array of mail exchange records with the following parameters:

name – DNS domain set for the record

ttl – time to live value

id – DNS zone ID

type – the type of the record. For this array, it is MX

priority - the mail server preference

hostname – DNS hostname

SRV – the array of service records with the following parameters 

name – DNS domain set for the record

ttl – time to live value

port – the port on this target host of this service.

weight – the proportion of traffic the server pointed to will handle.

priority – the priority of the target host

id – DNS zone ID

hostname – DNS hostname

A – the array of A host records with the following parameters:

name – DNS domain set for the record

ttl – time to live value

id – DNS zone ID

type – the type of the record. For this array, it is A

ip – domain IP

CNAME – the array of CNAME records with the following parameters:

name – DNS domain set for the record

ttl – time to live value

id – DNS zone ID

type – the type of the record. For this array, it is CNAME

hostname – DNS hostname

AAAA – the array of AAAA record with the following parameters:

name – DNS domain set for the record

ttl – time to live value

id – DNS zone ID

type – the type of the record. For this array, it is AAAA

ip – domain IP

TXT – the array of TXT record with the following parameters:

name – DNS domain set for the record

ttl – time to live value

id – DNS zone ID

txt – TXT value

type - the type of the record. For this array, it is TXT

NS – the array of name server records with the following parameters:

name – DNS domain set for the record

ttl – time to live value

id – DNS zone ID

type – the type of the record. For this array, it is NS

hostname – DNS hostname

SOA – the array of start of authority record with the following parameters:

name – DNS domain set for the record

serial – DNS zone serial number

primaryNs – primary name server

retry - the amount of time your secondary name servers will wait to contact the primary name server again if the last attempt failed

ttl – time to live value

id – DNS zone ID

refresh – the number of seconds between update requests

type – DNS record name. For this array, it is SOA

minimum – value of negative caching (in seconds)

expire - the number of seconds a server will wait before considering the data invalid if it cannot reach the primary name server

hostmaster – a hostmaster e-mail address

JSON Request example

 GET /dns_zones/:dns_zone_id/records.json 

JSON Response

 {
    "dns_zone": {
        "created_at": "2015-08-14T17:39:37+00:00",
        "id": 28,
        "name": "superb.com",
        "updated_at": "2015-08-14T17:39:37+00:00",
        "user_id": 337,
        "records": {
            "SOA": [
                {
                    "dns_record": {
                        "expire": 1209600,
                        "hostmaster": "1234567@superb.net",
                        "id": 1551238,
                        "minimum": 3600,
                        "name": "@",
                        "primaryNs": "ns1.superbcloud.net",
                        "refresh": 7200,
                        "retry": 900,
                        "serial": 2018625402,
                        "ttl": 86400,
                        "type": "SOA"
                    }
                }
            ],
            "NS": [
                {
                    "dns_record": {
                        "hostname": "ns1.superbcloud.net",
                        "id": 1551226,
                        "name": "@",
                        "ttl": 86400,
                        "type": "NS"
                    }
                },
                {
                    "dns_record": {
                        "hostname": "ns2.superbcloud.net",
                        "id": 1551229,
                        "name": "@",
                        "ttl": 86400,
                        "type": "NS"
                    }
                },
                {
                    "dns_record": {
                        "hostname": "ns3.superbcloud.net",
                        "id": 1551232,
                        "name": "@",
                        "ttl": 86400,
                        "type": "NS"
                    }
                },
                {
                    "dns_record": {
                        "hostname": "ns4.superbcloud.net",
                        "id": 1551235,
                        "name": "@",
                        "ttl": 86400,
                        "type": "NS"
                    }
                }
            ],
            "A": [
                {
                    "dns_record": {
                        "id": 1551244,
                        "ip": "74.84.144.4",
                        "name": "@",
                        "ttl": 300,
                        "type": "A"
                    }
                },
                {
                    "dns_record": {
                        "id": 1551247,
                        "ip": "74.84.144.4",
                        "name": "mail",
                        "ttl": 300,
                        "type": "A"
                    }
                },
                {
                    "dns_record": {
                        "id": 1551253,
                        "ip": "74.84.147.0",
                        "name": "www2",
                        "ttl": 300,
                        "type": "A"
                    }
                }
            ],
            "CNAME": [
                {
                    "dns_record": {
                        "hostname": "superb.com",
                        "id": 1551250,
                        "name": "www",
                        "ttl": 300,
                        "type": "CNAME"
                    }
                }
            ],
            "MX": [
                {
                    "dns_record": {
                        "hostname": "superb.com",
                        "id": 1551241,
                        "name": "@",
                        "priority": 1,
                        "ttl": 300,
                        "type": "MX"
                    }
                }
            ]
        },
        "cdn_reference": 782959610
    }

XML Request example

 GET /dns_zones/:dns_zone_id/records.xml

XML Response example

 <?xml version="1.0" encoding="UTF-8"?> dns_zone> <name>example.com</name> <created_at type="datetime">2012-01-19T16:53:47Z</created_at> <updated_at type="datetime">2012-01-19T16:53:47Z</updated_at> <id type="integer">322</id> <user_id type="integer">1</user_id> <records> <MX type="array"> <dns_record> <name>@</name> <ttl type="integer">3600</ttl> <priority type="integer">10</priority><id type="integer">3540</id>
<type>MX</type>
<hostname>mx1.me.com.akadns.net</hostname>
</dns_record>
</MX>
<SRV type="array">
<dns_record>
<name>_xmpp._tcp</name>
<ttl type="integer">86400</ttl>
<port type="integer">5222</port>
<weight type="integer">1</weight>
<priority type="integer">0</priority>
<id type="integer">4533</id><type>SRV</type>
<hostname>jabber.example.com</hostname>
</dns_record>
</SRV>
<A type="array">
<dns_record>
<name>@</name>
<ttl type="integer">20</ttl>
<id type="integer">3547</id>
<type>A</type>
<ip>17.172.192.8</ip>
</dns_record>
</A>
<CNAME type="array">
<dns_record>
<name>www</name>
<ttl type="integer">3600</ttl>
<id type="integer">3551</id>
<type>CNAME</type>
<hostname>www.me.com.edgekey.net</hostname>
</dns_record>
</CNAME>
<AAAA type="array">
<dns_record>
<name>sdfgeg</name>
<ttl type="integer">456</ttl>
<id type="integer">4052</id>
<type>AAAA</type>
<ip>::</ip>
</dns_record>
</AAAA>
<TXT type="array">
<dns_record>
<name>@</name>
<ttl type="integer">3600</ttl>
<id type="integer">3546</id>
<txt>v=spf1 ip4:17.0.0.0/8 ~all</txt>
<type>TXT</type>
</dns_record>
</TXT>
<NS type="array">
<dns_record>
<name>@</name>
<ttl type="integer">86400</ttl>
<id type="integer">3555</id>
<type>NS</type>
<hostname>ns1.testeteststestt.com</hostname>
</dns_record>
</NS>
<SOA type="array">
<dns_record>
<name>@</name>
<serial type="integer">2010111206</serial>
<primaryNs>ns1.testeteststestt.com</primaryNs>
<retry type="integer">172800</retry>
<ttl type="integer">86400</ttl>
<id type="integer">3539</id>
<refresh type="integer">12096007</refresh>
<type>SOA</type>
<minimum type="integer">1200</minimum>
<expire type="integer">2592000</expire>
<hostmaster>admin.example.com</hostmaster>
</dns_record>
</SOA>
</records>
</dns_zone>
  • No labels