Latest revision as of 23:11, 18 November 2014

GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}

Returns details of the domain name alias.

Request

GET /accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}

URI Parameters

accountNumber - string

The user account to which the domain name and the domain name alias belong

domainName - string

The target domain name (domain name under which the site is actually hosted)

aliasDomainName - string

The domain name that will act as alias to the target domain

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Response Body

{
    billingStatus: "{billingStatus}",
    "links": [
        {
            "href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/{aliasDomainName}",
            "rel": "self"
        }
    ]
}
 

Parameters

billingStatus - string

Current status of the domain name alias. Available values are pending, open, suspended, close_pending, closed

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.

links - list

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 or the domain name alias do not exist for the account

Examples

Successful retrieving domain name alias

Request

GET /accounts/test-account/web/test.com/aliases/test-alias.com
 

Response

{
    billingStatus: "open",
    "links": [
        {
            "href": "https://api.hostway.com/accounts/test-account/web/test.com/aliases/test-alias.com",
            "rel": "self"
        }
    ]
}