Comments are supported for domains and records and their requests and responses using the comment attribute. See the examples that follow.
Example: Response with comments: XML
Status: 200 OK
Date: Thu, 28 Jul 2011 21:54:21 GMT
X-API-VERSION: 1.0.17
Content-Type: application/xml
Content-Length: 3060
<domain>2725233</domain>
<accountId>1234</accountId>
<name>example.com</name>
<ttl>3600</ttl>
<emailAddress>[email protected]</emailAddress>
<updated>2011-06-24T01:23:15Z</updated>
<created>2011-06-24T01:12:51Z</created>
<comment>Optional domain comment..."</comment>
<nameservers>
<name>ns.rackspace.com</name>
</nameservers>
<nameservers>
<name>ns2.rackspace.com</name>
</nameservers>
<recordsList>
<totalEntries>6</totalEntries>
<records>
<id>A-6817754</id>
<type>A</type>
<name>ftp.example.com</name>
<data>192.0.2.8</data>
<ttl>5771</ttl>
<updated>2011-05-19T08:07:08-05:00</updated>
<created>2011-05-18T14:53:09-05:00</created>
</records>
<records>
<id>A-6822994</id>
<type>A</type>
<name>example.com</name>
<data>192.0.2.17</data>
<ttl>86400</ttl>
<updated>2011-06-24T01:12:52Z</updated>
<created>2011-06-24T01:12:52Z</created>
</records>
<records>
<id>NS-6251982</id>
<type>NS</type>
<name>example.com</name>
<data>ns.rackspace.com</data>
<ttl>3600</ttl>
<updated>2011-06-24T01:12:51Z</updated>
<created>2011-06-24T01:12:51Z</created>
<records>
<id>NS-6251983</id>
<type>NS</type>
<name>example.com</name>
<data>ns2.rackspace.com</data>
<ttl>3600</ttl>
<updated>2011-06-24T01:12:51Z</updated>
<created>2011-06-24T01:12:51Z</created>
</records>
<records>
<id>MX-3151218</id>
<type>MX</type>
<name>example.com</name>
<data>mail.example.com</data>
<ttl>3600</ttl>
<priority>5</priority>
<updated>2011-06-24T01:12:53Z</updated>
<created>2011-06-24T01:12:53Z</created>
</records>
<records>
<id>CNAME-9778009</id>
<type>CNAME</type>
<name>www.example.com</name>
<data>example.com</data>
<ttl>5400</ttl>
<updated>2011-06-24T01:12:54Z</updated>
<created>2011-06-24T01:12:54Z</created>
<comment>This is a comment on the CNAME record</comment>
</records>
</recordsList>
<subdomains>
<totalEntries>4</totalEntries>
<domains>
<id>2725257</id>
<name>sub1.example.com</name>
<emailAddress>[email protected]</emailAddress>
<updated>2011-06-23T03:09:34Z</updated>
<created>2011-06-23T03:09:33Z</created>
<comment>1st sample subdomain</comment>
</domains>
<domains>
<id>2725258</id>
<name>sub2.example.com</name>
<emailAddress>[email protected]</emailAddress>
<updated>2011-06-23T03:52:55Z</updated>
<created>2011-06-23T03:52:55Z</created>
<comment>1st sample subdomain</comment>
</domains>
<domains>
<id>2725260</id>
<name>north.example.com</name>
<emailAddress>[email protected]</emailAddress>
<updated>2011-06-23T03:53:10Z</updated>
<created>2011-06-23T03:53:09Z</created>
</domains>
<domains>
<id>2725261</id>
<name>south.example.com</name>
<emailAddress>[email protected]</emailAddress>
<updated>2011-06-23T03:53:14Z</updated>
<created>2011-06-23T03:53:14Z</created>
<comment>Final sample subdomain</comment>
</domains>
</subdomains>
Example: Response with comments: JSON
Status: 200 OK
Date: Thu, 28 Jul 2011 21:54:21 GMT
X-API-VERSION: 1.0.17
Content-Type: application/json
Content-Length: 3020
{
"name" : "example.com",
"id" : 2725233,
"comment" : "Optional domain comment...",
"updated" : "2011-06-24T01:23:15.000+0000",
"nameservers" : [ {
"name" : "ns.rackspace.com"
}, {
"name" : "ns2.rackspace.com"
} ],
"accountId" : 1234,
"recordsList" : {
"totalEntries" : 6,
"records" : [ {
"name" : "ftp.example.com",
"id" : "A-6817754",
"type" : "A",
"data" : "192.0.2.8",
"updated" : "2011-05-19T13:07:08.000+0000",
"ttl" : 5771,
"created" : "2011-05-18T19:53:09.000+0000"
}, {
"name" : "example.com",
"id" : "A-6822994",
"type" : "A",
"data" : "192.0.2.17",
"updated" : "2011-06-24T01:12:52.000+0000",
"ttl" : 86400,
"created" : "2011-06-24T01:12:52.000+0000"
}, {
"name" : "example.com",
"id" : "NS-6251982",
"type" : "NS",
"data" : "ns.rackspace.com",
"updated" : "2011-06-24T01:12:51.000+0000",
"ttl" : 3600,
"created" : "2011-06-24T01:12:51.000+0000"
}, {
"name" : "example.com",
"id" : "NS-6251983",
"type" : "NS",
"data" : "ns2.rackspace.com",
"updated" : "2011-06-24T01:12:51.000+0000",
"ttl" : 3600,
"created" : "2011-06-24T01:12:51.000+0000"
}, {
"name" : "example.com",
"priority" : 5,
"id" : "MX-3151218",
"type" : "MX",
"data" : "mail.example.com",
"updated" : "2011-06-24T01:12:53.000+0000",
"ttl" : 3600,
"created" : "2011-06-24T01:12:53.000+0000"
}, {
"name" : "www.example.com",
"id" : "CNAME-9778009",
"type" : "CNAME",
"comment" : "This is a comment on the CNAME record",
"data" : "example.com",
"updated" : "2011-06-24T01:12:54.000+0000",
"ttl" : 5400,
"created" : "2011-06-24T01:12:54.000+0000"
} ]
},
"subdomains" : {
"domains" : [ {
"name" : "sub1.example.com",
"id" : 2725257,
"comment" : "1st sample subdomain",
"updated" : "2011-06-23T03:09:34.000+0000",
"emailAddress" : "[email protected]",
"created" : "2011-06-23T03:09:33.000+0000"
}, {
"name" : "sub2.example.com",
"id" : 2725258,
"comment" : "1st sample subdomain",
"updated" : "2011-06-23T03:52:55.000+0000",
"emailAddress" : "[email protected]",
"created" : "2011-06-23T03:52:55.000+0000"
}, {
"name" : "north.example.com",
"id" : 2725260,
"updated" : "2011-06-23T03:53:10.000+0000",
"emailAddress" : "[email protected]",
"created" : "2011-06-23T03:53:09.000+0000"
}, {
"name" : "south.example.com",
"id" : 2725261,
"comment" : "Final sample subdomain",
"updated" : "2011-06-23T03:53:14.000+0000",
"emailAddress" : "[email protected]",
"created" : "2011-06-23T03:53:14.000+0000"
} ],
"totalEntries" : 4
},
"ttl" : 3600,
"emailAddress" : "[email protected]",
"created" : "2011-06-24T01:12:51.000+0000"
}
Notes for comments:
- Are limited to 160 characters each
- Can be any text characters
- Are optional
- To remove a comment, set it to the empty string, for example: comment=””
- Are returned on GET calls for both domain and records regardless of whether the call is a single or multiple call, and regardless of whether it is a detail or non-detail call
In summary, all Create Domain and Create Record(s) and all Modify Domain and Modify Record(s) calls can take an optional comment (comment="value of comment"). In other words, all these request calls can have an optional comment attribute.