Accounts-accountNumber-web-domainName-aliases:POST - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:16:38Z

1 revision: Release 109

Velimira.metodieva: /* Examples */

2015-04-06T14:20:35Z

Examples

Mike.robski: 1 revision: Release 105

2015-04-03T17:57:25Z

1 revision: Release 105

Mike.robski at 18:12, 27 March 2015

2015-03-27T18:12:56Z

New page

= GET /accounts/{accountNumber}/web/{domainName}/aliases =
Creates domain name alias.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/aliases</code>

=== 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)

=== Request Headers ===
{{Authorization}}

=== Request Body ===
<nowiki>
{
"domainAlias": "{domainAlias}"
}
</nowiki>

==== Parameters ====
; domainAlias - ''string''
: A valid domain name. Required.

== Response ==

=== Status Code ===
; 202 Accepted
: Success

; 400 Bad Request
: The format of the request body is invalid or the alias does not meet the requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The domain name does not exist.

; 409 Conflict
: The mailbox already exists(on create) or domain is disabled(on update).

== Examples ==

=== Failure creating a domain alias when required parameter is missing ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/aliases

{"domainAlias": ""}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"domainAlias": "Required"}}}

</nowiki>

=== Failure creating a domain alias when passing invalid parameter ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/aliases

{"domainAlias": "alias"}
</nowiki>

'''Response'''
<nowiki>
400 Bad Request

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"domainAlias": "Invalid domain name in domainAlias: test"}}}

</nowiki>

=== Successfully creating a domain alias ===
'''Request'''
<nowiki>
POST accounts/{account}/email/test.com/aliases

{"domainAlias": "alias.com"}
</nowiki>

'''Response'''
<nowiki>
202 Accepted

</nowiki>
=== ===

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

@@ Line 1: / Line 1: @@
-= GET /accounts/{accountNumber}/web/{domainName}/aliases =
+= POST /accounts/{accountNumber}/web/{domainName}/aliases =
 Creates domain name alias.
@@ Line 20: / Line 20: @@
   <nowiki>
+{
-     "domainAlias": "{domainAlias}"
+     "alias": "{alias}"
+}
   </nowiki>
 ==== Parameters ====
-; domainAlias - ''string''
+; alias - ''string''
 : A valid domain name. Required.
@@ Line 44: / Line 44: @@
 ; 409 Conflict
-: The mailbox already exists(on create) or domain is disabled(on update).
+: The alias already exists(on create) or domain is disabled(on update).
 == Examples ==
@@ Line 51: / Line 51: @@
 '''Request'''
   <nowiki>
-POST accounts/{account}/email/test.com/aliases
+POST /accounts/test-account/email/test.com/aliases
-{"domainAlias": ""}
+{"alias": ""}
   </nowiki>
@@ Line 60: / Line 60: @@
 Bad Request
-{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"domainAlias": "Required"}}}
+{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"alias": "Required"}}}
   </nowiki>
@@ Line 67: / Line 67: @@
 '''Request'''
   <nowiki>
-POST accounts/{account}/email/test.com/aliases
+POST /accounts/test-account/email/test.com/aliases
-{"domainAlias": "alias"}
+{"alias": "alias"}
   </nowiki>
@@ Line 76: / Line 76: @@
 Bad Request
-{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"domainAlias": "Invalid domain name in domainAlias: test"}}}
+{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"alias": "Invalid domain name in alias: test"}}}
   </nowiki>
@@ Line 83: / Line 83: @@
 '''Request'''
   <nowiki>
-POST accounts/{account}/email/test.com/aliases
+POST /accounts/test-account/email/test.com/aliases
-{"domainAlias": "alias.com"}
+{"alias": "alias.com"}
   </nowiki>