Subdomains operations

Use the Subdomains operation to view information about the subdomains for a specified domain.

List subdomains

GET /v1.0/{account}/domains/{domainId}/subdomains

Lists domains that are subdomains of the specified domain.

This call provides a list of all DNS domains that are subdomains for a specified domain. The resulting list is flat, and does not break the domains down hierarchically by subdomain.

ℹ️
By default, returns a maximum of 100 items at a time if no limit is specified. To navigate the collection returned, the parameters limit and offset can be set in the URI (for example: limit=10 & offset=0 ). Refer to Paginated collections.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.
400	Bad Request	The request is missing one or more elements, or the values of some elements are invalid.
400 500	dnsFault	The DNS service has experienced a fault.
401	Unauthorized	You are not authorized to complete this operation. This error can occur if the request is submitted with an invalid authentication token.
404	Not Found	The requested item was not found.
413	Over Limit	The number of items returned is above the allowed limit.
503	Service Unavailable	The service is not available.

Request

This table shows the header parameters for the request:

Name	Type	Description
X-Auth-Token	String	Arbitrary character string generated by the authentication service in response to valid credentials.

This table shows the URI parameters for the request:

Name	Type	Description
{account}	String	The tenant ID.
{domainId}	String	ID for the domain.

This operation does not accept a request body.

Example List subdomains: XML request

GET https://dns.api.rackspacecloud.com/v1.0/1234/domains/2725233/subdomains
Accept: application/xml  
X-Auth-Token: ea85e6ac-baff-4a6c-bf43-848020ea3812  
Content-Type: application/xml  
Content-Length: 0

Example List subdomains: JSON request

GET https://dns.api.rackspacecloud.com/v1.0/1234/domains/2725233/subdomains  
Accept: application/json  
X-Auth-Token: ea85e6ac-baff-4a6c-bf43-848020ea3812  
Content-Type: application/json  
Content-Length: 0

Response

Example List subdomains: XML response

Status: 200 OK  
Date: Thu, 28 Jul 2011 21:54:21 GMT  
X-API-VERSION: 1.0.17  
Content-Type: application/xml  
Content-Length: 1038
 
<domains>
    <id>2725257</id>
    <name>sub1.example.com</name>
    <comment>1st sample subdomain</comment>
    <emailAddress>[email protected]</emailAddress>
    <updated>2011-06-23T03:09:34Z</updated>
    <created>2011-06-23T03:09:34Z</created>
</domains>
<domains>
    <id>2725258</id>
    <name>sub2.example.com</name>
    <comment>2nd sample subdomain</comment>
    <emailAddress>[email protected]</emailAddress>
    <updated>2011-06-23T03:52:55Z</updated>
    <created>2011-06-23T03:52:55Z</created>
</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>
    <comment>Final sample subdomain</comment>
    <emailAddress>[email protected]</emailAddress>
    <updated>2011-06-23T03:53:14Z</updated>
    <created>2011-06-23T03:53:14Z</created>
</domains>
<totalEntries>4</totalEntries>

Example List subdomains: JSON response

Status: 200 OK  
Date: Thu, 28 Jul 2011 21:54:21 GMT  
X-API-VERSION: 1.0.17  
Content-Type: application/json  
Content-Length: 966

{  
  "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  
}

List subdomains

ℹ️By default, returns a maximum of 100 items at a time if no limit is specified. To navigate the collection returned, the parameters limit and offset can be set in the URI (for example: limit=10 & offset=0 ). Refer to Paginated collections.

Request

Response

ℹ️
By default, returns a maximum of 100 items at a time if no `limit` is specified. To navigate the collection returned, the parameters `limit` and `offset` can be set in the URI (for example: `limit=10 & offset=0` ). Refer to Paginated collections.