View source

= GET /dns/''{zone}'' =
Returns the details of a DNS zone.
__TOC__
== Request ==
<code>GET /dns/''{zone}''</code>

==== Parameters ====
; zone - ''string''
: The name of the DNS zone.

=== 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.

;403 Forbidden
: The server denies the access to the resource.

;404 Not Found
: The specified zone does not exist.

=== Response Body ===
 <nowiki>
{
  "minimumTTL": {minimumTTL},
  "retry": {retry},
  "name": "{zone}",
  "primaryNS": "{primaryNS}",
  "refresh": {refresh},
  "expire": {expire},
  "emailAddress": "{emailAddress}",
  "ttl": {ttl},
  "serial": {serial},
  "links": [
    {"href": "</nowiki>{{APIBaseURL}}<nowiki>/dns/{zone}", "rel": "self"},
    {"href": "</nowiki>{{APIBaseURL}}<nowiki>/dns/{zone}/records", "rel": "related"}
  ]
}
</nowiki>

== Examples ==
''Request:''
 <nowiki>
GET /dns/test.com
 </nowiki>

''Response:''
 <nowiki>
401 Unauthorized 
 </nowiki>

''Request:''
 <nowiki>
GET /dns/unknown-zone.com
Authorization: Basic {base64_encoded(username:password)}
 </nowiki>

''Response:''
 <nowiki>
403 Forbidden

{
  "forbidden": {"message": "Unauthorized: Dns failed permission check", "code": 403, "details": ""}
}
 </nowiki>

''Request:''
 <nowiki>
GET /dns/test.com
Authorization: Basic {base64_encoded(username:password)}
 </nowiki>

''Response:''
 <nowiki>
200 OK

{
  "minimumTTL": 300,
  "retry": 7200,
  "name": "test.com.",
  "links": [
    {"href": "http://127.0.0.1/dns/test.com/", "rel": "self"},
    {"href": "http://127.0.0.1/dns/test.com/records", "rel": "related"}
  ],
  "primaryNS": "a.dns.hostway.net.",
  "refresh": 28800,
  "expire": 604800,
  "emailAddress": "hostmaster.siteprotect.com.",
  "ttl": 14400,
  "serial": 1359151749
}
 </nowiki>

== See also ==
* [[DNS|DNS API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:DNS API]]