Dns-franchise-zone-rr:GET

Kj.lee (Talk)

Newer edit →

---

GET /dns/{franchise}/{zone}/rr

Returns the resource records for a specific DNS zone.

Request

GET /dns/{franchise}/{zone}/rr

Parameters

franchise - string

franchise

zone - string

The name of the DNS zone.

URI Parameters

name

Optional. Specifies the record name to use to filter results.

type

Optional. Specifies the type of records to return: A, AAAA, NS, TXT, SRV, MX, CNAME

page - number

Optional. Specifies the page to return in paginated response. Default is 1.

pageSize - number

Optional. Specifies the number of records per page.

Request Headers

Authorization

Base64-encoded username:password string

Response

Status Code

200 OK

Success

401 Unauthorized

The server could not verify the credentials from the authorization header.

404 Not Found

The specified zone does not exist.

Response Body

{
  "count": 2,
  "list": [
    {
      "id": {id},
      "name": "{domain}",
      "type: "AAAA",
      "ttl": {ttl},
      "address": "{ipv6_address}",
      "links": [
        {"href": "https://api.hostway.com/dns/{zone}/records/{id}/", "rel": "self"}
      ]
    },
    {
      "id": {id},
      "name": "{domain}",
      "type: "A",
      "ttl": {ttl},
      "address": "{ipv4_address}",
      "links": [
        {"href": "https://api.hostway.com/dns/{zone}/records/{id}/", "rel": "self"}
      ]
    }
  ],
  "page": 1,
  "pageSize": 10,
}

See also

• DNS API
• Common Features

blog comments powered by Disqus