Accounts-account-email-domain-alaises:GET
From Hostway API Documentation
(Difference between revisions)
(→Response Body) |
Mike.robski (Talk | contribs) m (1 revision: Release 100) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 67: | Line 67: | ||
"links": [ | "links": [ | ||
{ | { | ||
| − | "href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/aliases/", | + | "href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account123/email/test.com/aliases/", |
"rel": "self" | "rel": "self" | ||
} | } | ||
| Line 75: | Line 75: | ||
== See also == | == See also == | ||
| − | * [[Email | + | * [[Email API|Email API]] |
{{disqus}} | {{disqus}} | ||
[[Category:Hostway API]] | [[Category:Hostway API]] | ||
[[Category:Email API]] | [[Category:Email API]] | ||
Latest revision as of 00:10, 19 November 2014
[edit] GET /accounts/{account}/email/{domain}/aliases
Retrieves a list of aliases for a specific account and domain
Contents |
[edit] Request
GET /accounts/{account}/email/{domain}/aliases
[edit] 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
[edit] Response
[edit] 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.
[edit] Response Body
{
"list": [
"{alias}"
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
[edit] 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
[edit] Examples
[edit] 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"
}
]
}
[edit] See also
