Mike.robski: 1 revision: Release 109

2015-07-24T18:16:38Z

1 revision: Release 109

Velimira.metodieva: /* POST /accounts/{accountNumber}/web/{domainName}/subdomains */

2015-04-20T13:51:12Z

POST /accounts/{accountNumber}/web/{domainName}/subdomains

New page

= POST /accounts/{accountNumber}/web/{domainName}/subdomains =
Creates subdomain.

__TOC__

== Request ==
<code>POST /accounts/{accountNumber}/web/{domainName}/subdomains</code>

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

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

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

==== Parameters ====
; subdomain - ''string''
: A valid subdomain. Required.

== Response ==

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

; 400 Bad Request
: The format of the request body is invalid or the subdomain 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 sub domain already exists(on create) or domain is disabled(on update).

== Examples ==

=== Failure creating a subdomain when required parameter is missing ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/subdomains

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

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

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

</nowiki>

=== Failure creating a subdomain when passing invalid parameter ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/subdomains

{"subdomain": "subtest4-subtest4-subtest4-subtest4-subtest4-subtest4-subtest4ab"}
</nowiki>

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

{"badRequest": {"guid": "", "message": "POST data error", "code": 400, "details": {"subdomain": "Invalid subdomain name: subtest4-subtest4-subtest4-subtest4-subtest4-subtest4-subtest4ab"}}}

</nowiki>

=== Successfully creating a subdomain ===
'''Request'''
<nowiki>
POST /accounts/test-account/email/test.com/subdomains

{"subdomain": "sub"}
</nowiki>

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

{
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/web/test.dom/subdomains/", "rel": "self"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/action/", "rel": "submit"},
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/123/quote/", "rel": "quote"}]
}
</nowiki>

'''Request'''
<nowiki>
POST /orders/123/action

{"action": "submit"}
</nowiki>

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

=== ===

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

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

Mike.robski: 1 revision: Release 109

Velimira.metodieva: /* POST /accounts/{accountNumber}/web/{domainName}/subdomains */