http://docs.hostway.com/index.php?action=history&feed=atom&title=Accounts-accountNumber-web-domainName-aliases-AliasDomainName%3AGETAccounts-accountNumber-web-domainName-aliases-AliasDomainName:GET - Revision history2026-04-15T08:54:05ZRevision history for this page on the wikiMediaWiki 1.18.0http://docs.hostway.com/index.php?title=Accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET&diff=1903&oldid=prevMike.robski: 1 revision: Release 1002014-11-19T05:11:49Z<p>1 revision: Release 100</p>
<table class='diff diff-contentalign-left'>
<tr valign='top'>
<td colspan='1' style="background-color: white; color:black;">← Older revision</td>
<td colspan='1' style="background-color: white; color:black;">Revision as of 05:11, 19 November 2014</td>
</tr></table>Mike.robskihttp://docs.hostway.com/index.php?title=Accounts-accountNumber-web-domainName-aliases-AliasDomainName:GET&diff=1902&oldid=prevJerry.dimitrov: /* Parameters */2014-11-06T12:25:01Z<p><span class="autocomment">Parameters</span></p>
<p><b>New page</b></p><div>= GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName} =<br />
Returns details of the domain name alias.<br />
<br />
__TOC__<br />
<br />
== Request ==<br />
<code>GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}</code><br />
<br />
=== URI Parameters ===<br />
; accountNumber - ''string''<br />
: The user account to which the domain name and the domain name alias belong<br />
<br />
; domainName - ''string''<br />
: The target domain name (domain name under which the site is actually hosted)<br />
<br />
; aliasDomainName - ''string''<br />
: The domain name that will act as alias to the target domain<br />
<br />
=== Request Headers ===<br />
{{Authorization}}<br />
<br />
<br />
== Response ==<br />
<br />
=== Response Body ===<br />
<nowiki><br />
{<br />
billingStatus: "{billingStatus}",<br />
"links": [<br />
{<br />
"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}",<br />
"rel": "self"<br />
}<br />
]<br />
}<br />
</nowiki><br />
<br />
==== Parameters ====<br />
:; billingStatus - ''string''<br />
:: Current status of the domain name alias. Available values are '''pending''', '''open''', '''suspended''', '''close_pending''', '''closed'''<br />
:: '''pending''' means that the alias is still in the process of being provisioned. '''open''', '''suspended''', '''closed''' and '''close_pending''' means the alias is fully provisioned and usable.<br />
<br />
:; links - ''list''<br />
:: [[Hypermedia|Hypermedia]] for this resource<br />
<br />
=== Status Code ===<br />
; 200 OK<br />
: Success<br />
<br />
; 401 Unauthorized<br />
: The supplied credentials are invalid or do not provide permissions for this operation<br />
<br />
; 403 Forbidden<br />
: The authenticated user is not allowed to access this resource<br />
<br />
; 404 Not Found<br />
: The domain name or the domain name alias do not exist for the account<br />
<br />
== Examples ==<br />
<br />
=== Successful retrieving domain name alias ===<br />
'''Request'''<br />
<nowiki><br />
GET /accounts/test-account/web/test.com/aliases/test-alias.com<br />
</nowiki><br />
<br />
'''Response'''<br />
<nowiki><br />
{<br />
billingStatus: "open",<br />
"links": [<br />
{<br />
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.com/aliases/test-alias.com",<br />
"rel": "self"<br />
}<br />
]<br />
}<br />
</nowiki><br />
<br />
{{disqus}}<br />
[[Category:Hostway API]]<br />
[[Category:Web API]]</div>Jerry.dimitrov