Mike.robski: 1 revision: Release 109

2015-07-24T18:16:38Z

1 revision: Release 109

Velimira.metodieva: /* GET /accounts/{accountNumber}/web/{domainName}/subdomains */

2015-04-20T13:40:28Z

GET /accounts/{accountNumber}/web/{domainName}/subdomains

New page

= GET /accounts/{accountNumber}/web/{domainName}/subdomains =
Returns a list of the subdomains.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/subdomains</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the subdomains belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"list": [{"status": "{status}", "domain": "{domain}", "subdomain": "{subdomain}"},
{"status": "{status}", "domain": "{domain}", "subdomain": "{subdomain}"},
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/subdomains",
"rel": "self"}]
}
</nowiki>

==== Parameters ====
:; list - ''list''
:: A list, containing the status, the domain and the corresponding subdomain.

::; status - ''string''
::: Status of the subdomain. Currently only subdomains with status '''open''' are listed.

::; domain - ''string''
::: The domain name of the main web hosting product.

::; subdomains - ''string''
::: The subdomain.

:; links - ''list''
:: [[Hypermedia|Hypermedia]] for this resource

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name does not exist for the account

== Examples ==

=== Successful retrieving subdomains ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/subdomains
</nowiki>

'''Response'''
<nowiki>
{
"list":
[
{"status": "open", "domain": "test.com", "subdomain": "sub.test.com"},
{"status": "open", "domain": "test.com", "subdomain": "sub1.test.com"},
{"status": "open", "domain": "test.com", "subdomain": "sub1.v.test.com"}
],
"links":
[
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/subdomains/", "rel": "self"}
]
}
</nowiki>

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

Accounts-accountNumber-web-domainName-subdomains:GET - Revision history

Mike.robski: 1 revision: Release 109

Velimira.metodieva: /* GET /accounts/{accountNumber}/web/{domainName}/subdomains */