Dns-zone-records:POST - Revision history

Corinne.chui: 1 revision

2016-08-19T00:35:11Z

1 revision

Corinne.chui at 00:31, 19 August 2016

2016-08-19T00:31:28Z

Mike.robski: 1 revision: Release 100

2014-11-19T05:09:54Z

1 revision: Release 100

Mike.robski at 17:29, 16 October 2014

2014-10-16T17:29:06Z

Mike.robski: 1 revision: Release 99

2014-10-15T15:22:53Z

1 revision: Release 99

Mike.robski: /* See also */

2014-10-15T15:21:30Z

Mike.robski: 1 revision: Release 93

2014-05-08T07:35:23Z

1 revision: Release 93

Velko.hristov at 11:53, 25 April 2014

2014-04-25T11:53:29Z

Mike.robski: 1 revision

2013-02-18T23:04:03Z

1 revision

Mike.robski at 22:47, 18 February 2013

2013-02-18T22:47:26Z

New page

= POST /dns/''{zone}''/records =
Creates new DNS zone records.
__TOC__
== Request ==
<code>POST /dns/''{zone}''/records</code>

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

==== URI Parameters ====
None.

=== Request Headers ===
; Authorization
: Base64-encoded username:password string

; Content-Type
: application/json

=== Request Body ===

====A record====
<nowiki>
{
"name": "{domain}",
"type": "A",
"address": "{ip_address}"
}
</nowiki>

====AAAA record====
<nowiki>
{
"name": "{domain}",
"type": "AAAA",
"address": "{ipv6_address}"
}
</nowiki>

====NS record====
<nowiki>
{
"name": "{domain}",
"type": "NS",
"nsdname": "{ns_domain}"
}
</nowiki>

====TXT record====
<nowiki>
{
"name": "{domain}",
"type": "TXT",
"data": "{data}"
}
</nowiki>

====SRV record====
<nowiki>
{
"name": "{domain}",
"type": "SRV",
"priority": {priority},
"weight": {weight},
"port": {port},
"target": "{target}"
}
</nowiki>

====MX record====
<nowiki>
{
"name": "{domain}",
"type": "MX",
"preference": {preference},
"exchange": "{mx_domain}"
}
</nowiki>

====CNAME record====
<nowiki>
{
"name": "{name}",
"type": "CNAME",
"cname": "{domain}"
}
</nowiki>

== 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 Header ===
; Location
: The URI of the new DNS record.

== Examples ==

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

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}
</nowiki>

''Response''
<nowiki>
201 Created
Location: </nowiki>{{APIBaseURL}}<nowiki>/dns/test.com/records/447
</nowiki>

=== Unauthorized Request ===
''Request''
<nowiki>
POST /dns/test.com/records

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}
</nowiki>

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

=== Attempt to create duplicate record ===
''Request''
<nowiki>
POST /dns/test.com/records
Authorization: Basic {base64_encoded(username:password)}

{
"name": "test",
"type": "CNAME",
"cname": "otherdomain.com."
}
</nowiki>

''Response''
<nowiki>
409 Conflict

{
"conflict": {"message": "Data conflict", "code": 409, "details": ""}
}
</nowiki>

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

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

@@ Line 180: / Line 180: @@
 === Status Code ===
-; 200 OK : Success
+; 201 OK : Success
 ; 400 Bad Request : TTL is below allowed minimum

← Older revision		Revision as of 17:29, 16 October 2014
Line 187:		Line 187:

	; 404 Not Found : The specified zone does not exist.		; 404 Not Found : The specified zone does not exist.
		+
		+	; 409 Conflict : Requested record conflicts with existing one.

	=== Response Header ===		=== Response Header ===

@@ Line 34: / Line 34: @@
+       @
     The API will return the record with the zone origin appended to the name, i.e. '@.domain.com'
 ====A record====
   <nowiki>
@@ Line 42: / Line 43: @@
    "ttl": 3600
 }</nowiki>
 ====AAAA record====
@@ Line 51: / Line 61: @@
    "ttl": 3600
 }</nowiki>
 ====NS record====
@@ Line 60: / Line 79: @@
    "ttl": 3600
 }</nowiki>
 ====TXT record====
@@ Line 69: / Line 97: @@
    "ttl": 3600
 }</nowiki>
 ====SRV record====
@@ Line 81: / Line 118: @@
    "ttl": 3600
 }</nowiki>
 ====MX record====
@@ Line 91: / Line 146: @@
    "ttl": 3600
 }</nowiki>
 ====CNAME record====
@@ Line 100: / Line 167: @@
    "ttl": 3600
 }</nowiki>
 == Response ==
@@ Line 125: / Line 201: @@
+{
-   "name": "test",
+   "name": "alt.test.com",
    "type": "CNAME",
-   "cname": "otherdomain.com."
+   "cname": "altdomain.com"
 }</nowiki>
@@ Line 142: / Line 218: @@
+{
-   "name": "test",
+   "name": "alt.test.com",
    "type": "CNAME",
-   "cname": "otherdomain.com."
+   "cname": "altdomain.com"
 }</nowiki>
@@ Line 159: / Line 235: @@
+{
-   "name": "test",
+   "name": "alt.test.com",
    "type": "CNAME",
-   "cname": "otherdomain.com."
+   "cname": "altdomain.com"
 }</nowiki>
@@ Line 175: / Line 251: @@
 * [[DNS|DNS API]]
 * [[Common Features]]
 {{disqus}}
 [[Category:Hostway API]]
 [[Category:DNS API]]

@@ Line 21: / Line 21: @@
 === Request Body ===
 ====A record====
   <nowiki>
@@ Line 26: / Line 39: @@
    "name": "{domain}",
    "type": "A",
-   "address": "{ip_address}"
+   "address": "{ip_address}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 ====AAAA record====
@@ Line 35: / Line 48: @@
    "name": "{domain}",
    "type": "AAAA",
-   "address": "{ipv6_address}"
+   "address": "{ipv6_address}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 ====NS record====
@@ Line 44: / Line 57: @@
    "name": "{domain}",
    "type": "NS",
-   "nsdname": "{ns_domain}"
+   "nsdname": "{ns_domain}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 ====TXT record====
@@ Line 53: / Line 66: @@
    "name": "{domain}",
    "type": "TXT",
-   "data": "{data}"
+   "data": "{data}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 ====SRV record====
@@ Line 65: / Line 78: @@
    "weight": {weight},
    "port": {port},
-   "target": "{target}"
+   "target": "{target}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 ====MX record====
@@ Line 75: / Line 88: @@
    "type": "MX",
    "preference": {preference},
-   "exchange": "{mx_domain}"
+   "exchange": "{mx_domain}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 ====CNAME record====
@@ Line 84: / Line 97: @@
    "name": "{name}",
    "type": "CNAME",
-   "cname": "{domain}"
+   "cname": "{domain}",
+  "ttl": 3600
- </nowiki>
+}</nowiki>
 == Response ==
 === Status Code ===
-;200 OK
+; 200 OK : Success
 : Success
-;401 Unauthorized
+; 401 Unauthorized : The server could not verify the credentials from the authorization header.
 : The server could not verify the credentials from the authorization header.
-;404 Not Found
+; 404 Not Found : The specified zone does not exist.
 : The specified zone does not exist.
 === Response Header ===
@@ Line 116: / Line 128: @@
    "type": "CNAME",
    "cname": "otherdomain.com."
 }</nowiki>
- </nowiki>
 ''Response''
@@ Line 134: / Line 145: @@
    "type": "CNAME",
    "cname": "otherdomain.com."
 }</nowiki>
- </nowiki>
 ''Response''
@@ Line 152: / Line 162: @@
    "type": "CNAME",
    "cname": "otherdomain.com."
 }</nowiki>
- </nowiki>
 ''Response''
@@ Line 161: / Line 170: @@
+{
    "conflict": {"message": "Data conflict", "code": 409, "details": ""}
 }</nowiki>
- </nowiki>
 == See also ==
@@ Line 171: / Line 179: @@
 [[Category:Hostway API]]
 [[Category:DNS API]]