Change subdomain of a web hosting package
Change what a subdomain may be used for (web, mail), or its description.
manitu_webhosting_subdomain_set on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Changes a subdomain of a web hosting package of the manitu customer account this connection works in, by site_id and fqdn from manitu_webhosting_subdomain_list: for_web, for_mail, description - only the fields given. The name cannot change (delete and create anew). A service still in use cannot be switched off (conflict in_use, saying what uses it). When a service changes, the DNS zone of the domain follows - only where the zone is at manitu; elsewhere (dns_zone: not_at_manitu) the customer changes the records himself at his DNS provider, and nothing about the DNS is done before the answer says dns_zone: updated. mail.<domain> for the web needs confirm_web_on_mail_host (conflict web_on_mail_host). Refused with a conflict when the package cannot be changed now (not_configurable). Tell the customer what changes and ask for an explicit yes first.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
fqdnstringrequiredThe subdomain from manitu_webhosting_subdomain_list, e.g. cloud.example.de. Never guess one.
for_webbooleanMay be used for websites (vHosts). Default when created: true.
for_mailbooleanMay be used for mail addresses and mailing lists. Default when created: true.
descriptionstring | nullThe customer's description, for his own overview. Left out: unchanged (set) or none (create); null or empty: none.
dns_zone_updatebooleanMerge 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_hostbooleantrue: the customer knows that using mail.<domain> for the web may disturb his mail, and wants it anyway. Only after telling him.
Result structuredContent, checked against the schema
fqdnstringrequiredThe full name, e.g. cloud.example.de - what the other tools take. Unicode for an internationalized domain.
fqdn_asciistringrequiredThe same name as DNS has it (xn--... for an internationalized domain).
hoststringrequiredThe part before the domain, e.g. cloud - may have several levels (alt.intern).
domainstringrequiredThe domain of the package it is under.
for_webbooleanrequiredMay be used for websites (vHosts), redirects etc.
for_mailbooleanrequiredMay be used for mail addresses and mailing lists.
in_useobjectrequiredWhat uses it now - a used service cannot be switched off, a used subdomain not deleted.
in_use.webbooleanrequiredA website (vHost) has this name.
in_use.mailbooleanrequiredA mail address or mailing list is at this name.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
created_atstring | nullrequireddns_zonestringrequiredWhat 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.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
fqdnstringrequiredThe subdomain from manitu_webhosting_subdomain_list, e.g. cloud.example.de. Never guess one.
for_webbooleanMay be used for websites (vHosts). Default when created: true.
for_mailbooleanMay be used for mail addresses and mailing lists. Default when created: true.
descriptionstring | nullThe customer's description, for his own overview. Left out: unchanged (set) or none (create); null or empty: none.
dns_zone_updatebooleanMerge 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_hostbooleantrue: the customer knows that using mail.<domain> for the web may disturb his mail, and wants it anyway. Only after telling him.
Response in data; the rest of the body as on every call
fqdnstringrequiredThe full name, e.g. cloud.example.de - what the other tools take. Unicode for an internationalized domain.
fqdn_asciistringrequiredThe same name as DNS has it (xn--... for an internationalized domain).
hoststringrequiredThe part before the domain, e.g. cloud - may have several levels (alt.intern).
domainstringrequiredThe domain of the package it is under.
for_webbooleanrequiredMay be used for websites (vHosts), redirects etc.
for_mailbooleanrequiredMay be used for mail addresses and mailing lists.
in_useobjectrequiredWhat uses it now - a used service cannot be switched off, a used subdomain not deleted.
in_use.webbooleanrequiredA website (vHost) has this name.
in_use.mailbooleanrequiredA mail address or mailing list is at this name.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
created_atstring | nullrequireddns_zonestringrequiredWhat 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.
Statuses
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.