Create subdomain for a web hosting package

A new subdomain under one of the package's domains, e.g. cloud.example.de.

WWriteNot idempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_subdomain_createon https://mcp.manitu.de/mcp
POST
/v1/webhosting/subdomain/createon https://api.manitu.de
Try it
Changes the account. Agents say what will happen and wait for an explicit yes before calling it.
readOnlyHint falsedestructiveHint falseidempotentHint falseopenWorldHint false

Creates a subdomain for a web hosting package of the manitu customer account this connection works in, by its site_id from manitu_webhosting_list - under one of the package's domains (domain_list of manitu_webhosting_subdomain_list), e.g. cloud.example.de or alt.intern.example.de. A website (vHost) or mail addresses at that name need it first. Letters, digits and hyphens, not at the ends of a part. manitu's records for it are merged into the DNS zone only where the domain's zone is at manitu; elsewhere (dns_zone: not_at_manitu) the customer sets them himself at his DNS provider - do not tell the customer the DNS is done before the answer says dns_zone: updated. Refused with a conflict when the package allows no more subdomains (limit_reached), for mail.<domain> used for the web without confirm_web_on_mail_host (web_on_mail_host - tell the customer it may disturb his mail), or when the package cannot be changed now (not_configurable). Tell the customer the name and that the DNS zone changes, and ask for an explicit yes first.

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

pattern ^[1-9][0-9]*$min 1
fqdnstringrequired

The new subdomain, in full - e.g. cloud.example.de; Unicode or ASCII, any case.

min length 3max length 253
for_webboolean

May be used for websites (vHosts). Default when created: true.

for_mailboolean

May be used for mail addresses and mailing lists. Default when created: true.

descriptionstring | null

The customer's description, for his own overview. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
dns_zone_updateboolean

Merge manitu's records for the subdomain into the DNS zone of the domain (default true). false only if the customer keeps the zone by hand - then he must set the records himself.

confirm_web_on_mail_hostboolean

true: the customer knows that using mail.<domain> for the web may disturb his mail, and wants it anyway. Only after telling him.

fqdnstringrequired

The full name, e.g. cloud.example.de - what the other tools take. Unicode for an internationalized domain.

fqdn_asciistringrequired

The same name as DNS has it (xn--... for an internationalized domain).

hoststringrequired

The part before the domain, e.g. cloud - may have several levels (alt.intern).

domainstringrequired

The domain of the package it is under.

for_webbooleanrequired

May be used for websites (vHosts), redirects etc.

for_mailbooleanrequired

May be used for mail addresses and mailing lists.

in_useobjectrequired

What uses it now - a used service cannot be switched off, a used subdomain not deleted.

in_use.webbooleanrequired

A website (vHost) has this name.

in_use.mailbooleanrequired

A mail address or mailing list is at this name.

descriptionstring | nullrequired

What the customer wrote about it (his description), null if nothing - not its name or user name.

created_atstring | nullrequired
Format date-time
dns_zonestringrequired

What became of the DNS zone of the domain: updated - manitu's records for the subdomain were merged in (the customer's own MX, A and AAAA kept where possible; changes made by hand should be checked); skipped - not asked for or nothing to change; not_at_manitu - the zone is elsewhere, the customer must set the records there, else the subdomain does not work; failed - the subdomain is saved, the zone not - the customer should check it.

One of updated skipped not_at_manitu failed

One of X-API-Key, Authorization: Bearer … - never more than one in a request. More

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

pattern ^[1-9][0-9]*$min 1
fqdnstringrequired

The new subdomain, in full - e.g. cloud.example.de; Unicode or ASCII, any case.

min length 3max length 253
for_webboolean

May be used for websites (vHosts). Default when created: true.

for_mailboolean

May be used for mail addresses and mailing lists. Default when created: true.

descriptionstring | null

The customer's description, for his own overview. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
dns_zone_updateboolean

Merge manitu's records for the subdomain into the DNS zone of the domain (default true). false only if the customer keeps the zone by hand - then he must set the records himself.

confirm_web_on_mail_hostboolean

true: the customer knows that using mail.<domain> for the web may disturb his mail, and wants it anyway. Only after telling him.

fqdnstringrequired

The full name, e.g. cloud.example.de - what the other tools take. Unicode for an internationalized domain.

fqdn_asciistringrequired

The same name as DNS has it (xn--... for an internationalized domain).

hoststringrequired

The part before the domain, e.g. cloud - may have several levels (alt.intern).

domainstringrequired

The domain of the package it is under.

for_webbooleanrequired

May be used for websites (vHosts), redirects etc.

for_mailbooleanrequired

May be used for mail addresses and mailing lists.

in_useobjectrequired

What uses it now - a used service cannot be switched off, a used subdomain not deleted.

in_use.webbooleanrequired

A website (vHost) has this name.

in_use.mailbooleanrequired

A mail address or mailing list is at this name.

descriptionstring | nullrequired

What the customer wrote about it (his description), null if nothing - not its name or user name.

created_atstring | nullrequired
Format date-time
dns_zonestringrequired

What became of the DNS zone of the domain: updated - manitu's records for the subdomain were merged in (the customer's own MX, A and AAAA kept where possible; changes made by hand should be checked); skipped - not asked for or nothing to change; not_at_manitu - the zone is elsewhere, the customer must set the records there, else the subdomain does not work; failed - the subdomain is saved, the zone not - the customer should check it.

One of updated skipped not_at_manitu failed
200Success.400The request does not match the declared input schema.401No credential was presented, or it was not recognised.403The credential is not permitted to use this operation.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.