Accounts-accountNumber-web-domainName-subdomains-subDomain:GET

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

Returns details of the subdomain.

Request

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

URI Parameters

accountNumber - string

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

domainName - string

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

subDomain - string

The subdomain

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Response

Response Body

{
    "status": "{status}",  
    "domain": "{domainName}",
    "subdomain": "{subDomain}",
    "links": [
        {
            "href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/{subDomain}", "rel": "self",
            "href": "http://{server_name}/accounts/{accountNumber}/products/{productSpecificationId}", "rel": "product",
            "href": "http://{server_name}/accounts/{accountNumber}/products/{productSpecificationId}/services/{serviceSpecificationId}", "rel": "service"
        }
    ]
}
 

Parameters

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 for this resource. The list includes a link to the web hosting product and a link to the subdomain service.

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 subdomain do not exist for the account

Examples

Successful retrieving subdomain

Request

GET /accounts/test-account/web/test.com/subdomains/sub
 

Response

{
    "domain": "test.com",
    "subdomain": "sub.test.com",
    "links": [
        {
            "href": "https://api.hostway.com/accounts/acct1234/web/test.com/subdomains/sub", "rel": "self",
            "href": "https://api.hostway.com/accounts/acct1234/products/acct1234-00000149809de3951ac99317007f00000001000/", "rel": "product",
            "href": "https://api.hostway.com/accounts/acct1234/products/acct1234-00000149809de3951ac99317007f00000001000/services/acct1234-0000014c8e39bf39a2fc8945007f00000001000/", "rel": "service"
        }
    ]
}

blog comments powered by Disqus