Revision as of 12:34, 5 November 2014

GET /accounts/{account}/email/{domain}/aliases

Retrieves a list of aliases for a specific account and domain

Request

GET /accounts/{account}/email/{domain}/aliases

Request Parameters

account - string

The user account owning the domain and the mailboxes

domain - string

The specific domain for which the call will retrieve the list

Response

Status Code

200 OK

Success

401 Unauthorized

The supplied credentials are invalid or do not provide permissions for this operation.

404 Not Found

The domain name or account does not exist.

Response Body

{
    "list": [
        "{alias}"
    ],
    "links": [
        {
            "href": "{href}",
            "rel": "{rel}"
        }
    ]
}
 

Parameters

alias - string

Domain name alias

href - string

Link to other resources relevant to the mailboxes lists

rel - string

Type of relation to the resource for the provided link

Examples

Success scenario

Request

GET accounts/test-account123/email/test.com/aliases
 

Response

{
    "list": [
        "test-alias.com", "test-alias-2.com"
    ],
    "links": [
        {
            "href": "https://api.hostway.com/accounts/test-account123/email/test.com/aliases/",
            "rel": "self"
        }
    ]
}
 

See also

• Email API