Corinne.chui: 1 revision

2016-05-30T19:34:22Z

1 revision

Jerry.dimitrov: /* Response */

2015-11-16T16:05:24Z

Response

Mike.robski: 1 revision

2013-02-18T23:04:03Z

1 revision

Mike.robski at 04:52, 18 February 2013

2013-02-18T04:52:33Z

New page

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

;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]]

@@ Line 21: / Line 21: @@
 ;401 Unauthorized
 : The server could not verify the credentials from the authorization header.
 ;404 Not Found

Dns-zone:GET - Revision history

Corinne.chui: 1 revision

Jerry.dimitrov: /* Response */

Mike.robski: 1 revision

Mike.robski at 04:52, 18 February 2013