Accounts-account-email-domain-alaises:GET - Revision history

Mike.robski: 1 revision: Release 100

2014-11-19T05:10:23Z

1 revision: Release 100

Jerry.dimitrov: /* Success scenario */

2014-11-05T18:34:41Z

Success scenario

Mike.robski: 1 revision: Release 91

2014-03-11T17:18:16Z

1 revision: Release 91

Mike.robski at 17:17, 11 March 2014

2014-03-11T17:17:44Z

Mike.robski: 1 revision: Release 90

2014-01-31T18:37:33Z

1 revision: Release 90

Velimira.metodieva: /* Response Body */

2014-01-23T15:03:56Z

Response Body

New page

= GET /accounts/{account}/email/{domain}/aliases =
Retrieves a list of aliases for a specific account and domain
__TOC__

== Request ==
<code>GET /accounts/{account}/email/{domain}/aliases</code>

==== 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 ===
<nowiki>
{
"list": [
"{alias}"
],
"links": [
{
"href": "{href}",
"rel": "{rel}"
}
]
}
</nowiki>

==== 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'''
<nowiki>
GET accounts/test-account123/email/test.com/aliases
</nowiki>

'''Response'''
<nowiki>
{
"list": [
"test-alias.com", "test-alias-2.com"
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/aliases/",
"rel": "self"
}
]
}
</nowiki>

== See also ==
* [[Email Service API|Email Service API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Email API]]

@@ Line 67: / Line 67: @@
      "links": [
+         {
-             "href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/aliases/",
+             "href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account123/email/test.com/aliases/",
              "rel": "self"
+         }

@@ Line 75: / Line 75: @@
 == See also ==
-* [[Email Service API|Email Service API]]
+* [[Email API|Email API]]
 {{disqus}}
 [[Category:Hostway API]]
 [[Category:Email API]]