Dns-franchise-zone-rr:GET

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
 
m (1 revision: Release 110)
 
(4 intermediate revisions by 3 users not shown)
Line 21: Line 21:
 
: Optional. Specifies the page to return in paginated response. Default is 1.
 
: Optional. Specifies the page to return in paginated response. Default is 1.
  
; pageSize - ''number''
+
; page_size - ''number''
 
: Optional. Specifies the number of records per page.
 
: Optional. Specifies the number of records per page.
  
Line 51: Line 51:
 
       "ttl": {ttl},
 
       "ttl": {ttl},
 
       "address": "{ipv6_address}",
 
       "address": "{ipv6_address}",
       "links": [
+
       "owner": "{owner}"
        {"href": "</nowiki>{{APIBaseURL}}<nowiki>/dns/{zone}/records/{id}/", "rel": "self"}
+
      ]
+
 
     },
 
     },
 
     {
 
     {
Line 61: Line 59:
 
       "ttl": {ttl},
 
       "ttl": {ttl},
 
       "address": "{ipv4_address}",
 
       "address": "{ipv4_address}",
       "links": [
+
       "owner": null
        {"href": "</nowiki>{{APIBaseURL}}<nowiki>/dns/{zone}/records/{id}/", "rel": "self"}
+
      ]
+
 
     }
 
     }
 
   ],
 
   ],

Latest revision as of 11:53, 20 August 2015

[edit] GET /dns/{franchise}/{zone}/rr

Returns the resource records for a specific DNS zone.

Contents

[edit] Request

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

[edit] Parameters

franchise - string
franchise
zone - string
The name of the DNS zone.

[edit] 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.
page_size - number
Optional. Specifies the number of records per page.

[edit] Request Headers

Authorization
Base64-encoded username:password string

[edit] Response

[edit] 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.

[edit] Response Body

{
  "count": 2,
  "list": [
    {
      "id": {id},
      "name": "{domain}",
      "type: "AAAA",
      "ttl": {ttl},
      "address": "{ipv6_address}",
      "owner": "{owner}"
    },
    {
      "id": {id},
      "name": "{domain}",
      "type: "A",
      "ttl": {ttl},
      "address": "{ipv4_address}",
      "owner": null
    }
  ],
  "page": 1,
  "pageSize": 10,
}

[edit] See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox