Latest revision as of 10:08, 14 October 2014

[edit] PUT /dns/{zone}/records/{recordId}

Update an existing zone record.

[edit] Request

PUT /dns/{zone}/records/{recordId}

[edit] Request Parameters

zone - string

The DNS zone of the record.

recordId - string

The uniques Id of the record.

[edit] URI Parameters

None.

[edit] Request Headers

Content-Type

application/json

Authorization

Base64-encoded username & password string

[edit] Request Body

 Added support for wildcard domain names.
  Ex:
     *
     *.somedomain.com
  The wildcard record name is stored in the database as it is supplied.
  If it's missing the zone origin(i.e. '*') the API will return it with the zone
  appended, i.e. '*.domain.com'.
  

  Added support for @ records, which represent the origin itself.
  Ex:
     @
  The API will return the record with the zone origin appended to the name, i.e. '@.domain.com'

[edit] A record

{ 
    "name": {domain},
    "address": {ip_address},
    "ttl": 3600
}

[edit] AAAA record

{ 
    "name": {domain},
    "address": {ipv6_address},
    "ttl": 3600
}

[edit] NS record

{ 
    "name": {domain}, 
    "nsdname": {ns_domain},
    "ttl": 3600
}

[edit] TXT record

{ 
    "name": {domain},
    "data": {data},
    "ttl": 3600
}

[edit] SRV record

{ 
    "name": {domain},
    "priority": {priority}, 
    "weight": {weight}, 
    "port": {port}, 
    "target": {target},
    "ttl": 3600
}

[edit] MX record

{ 
    "name": {domain}, 
    "preference": {preference}, 
    "exchange": {mx_domain},
    "ttl": 3600
}

[edit] CNAME record

{ 
    "name": {name},
    "cname": {domain},
    "ttl": 3600
}

[edit] Response

[edit] Status Code

200 OK 

Success

400 Bad Request 

TTL is below allowed minimum

401 Unauthorized 

403 Forbidden 

409 Conflict 

[edit] Response Body

None.

[edit] Examples

[edit] Unauthorized Request

Request

PUT /dns/test.com/records/1234

{
  "name": "test",
  "cname": "otherdomain.com."
}

Response

401 Unauthorized 

[edit] Successful Update

Request

PUT /dns/test.com/records/1234
Authorization: Basic {base64_encoded(username:password)}

{
  "name": "test1",
  "cname": "otherdomain1.com."
}

Response

200 OK

{
  "name": "test1",
  "type": "CNAME",
  "cname": "otherdomain1.com."
}

[edit] See also

• DNS API
• Common Features