Convert website of a web hosting package
Make a website an alias of another one, or an alias a website of its own.
manitu_webhosting_web_vhost_convert on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Converts a website (vHost) of a web hosting package of the manitu customer account this connection works in, by site_id and fqdn from manitu_webhosting_web_vhost_list. to alias (alias_of required - another website, not an alias): it then shows what that website shows, with its HTTPS settings; its own folder or redirect, HSTS and alternative hostname are given up for good, its own aliases move to that website (moved_alias_list). to website: an alias becomes a website of its own and keeps showing what it showed, changeable with manitu_webhosting_web_vhost_set. Status, certificate and description stay. A websitebuilder cannot be converted (not_convertible); converting to the type it has is a conflict (already_type). Takes up to an hour everywhere. Refused with a conflict when the package cannot be changed now (not_configurable). Tell the customer what is given up and ask for an explicit yes first.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
fqdnstringrequiredThe website from manitu_webhosting_web_vhost_list, e.g. shop.example.de. Never guess one.
tostringrequiredwebsite or alias.
alias_ofstringFor to alias - required then: the website (or websitebuilder) it belongs to, by fqdn from manitu_webhosting_web_vhost_list. Not an alias, not itself.
redirect_to_parentbooleanFor to alias: redirect visitors to that website's name (HTTP 301, default true); false: show the same under its own name.
Result structuredContent, checked against the schema
fqdnstringrequiredThe name, e.g. www.example.de - a domain or subdomain of the package; what the other tools take. Unicode for an internationalized domain.
fqdn_asciistringrequiredThe same name as DNS has it (xn--... for an internationalized domain).
typestringrequiredwebsite (the customer's files from a folder, or a redirect to a URL), websitebuilder (made with manitu's website builder) or alias (a further name of a website - see alias).
statusstringrequiredinactive: switched off, the files are kept - visitors get when_inactive.
when_inactiveobjectrequiredWhat visitors get while it is inactive.
when_inactive.responsestringrequiredAn HTTP status (403, 404, 503 - 503 tells search engines to come back), hide (as if there were no website) or page (a page of manitu's, see page).
when_inactive.pagestring | nullrequiredWhich page, for response page: disabled, underconstruction or maintenance.
websiteobject | nullrequiredFor type website, else null.
website.target_dirstring | nullrequiredThe folder shown, relative to the web root, e.g. /htdocs/www.example.com/ (the older layout: /web/...) - see manitu_webhosting_web_structure_get; null when it redirects.
website.redirect_urlstring | nullrequiredThe URL every visitor is sent to - null when it shows a folder.
website.allow_wordpress_xmlrpcbooleanrequiredWordPress' XML-RPC interface reachable - off by default, a frequent target of brute force attacks that manitu's firewall cannot block.
websitebuilderobject | nullrequiredFor type websitebuilder, else null. The editor opens with manitu_webhosting_web_vhost_websitebuilder_get.
websitebuilder.target_dirstringrequiredThe folder manitu set for it - not to be changed.
aliasobject | nullrequiredFor type alias, else null. An alias shows what its website shows, with its HTTPS settings; status, certificate and description are its own.
alias.ofstring | nullrequiredThe website it belongs to (fqdn) - null only for an old alias that lost it.
alias.redirect_to_parentbooleanrequiredVisitors are redirected to the website's name (HTTP 301); false: the alias shows the same under its own name.
httpsobject | nullrequiredFor a website or websitebuilder; null for an alias (its website's apply).
https.redirectbooleanrequiredVisitors coming with http:// are sent to https://.
https.hstsobjectrequiredHSTS (Strict-Transport-Security): browsers remember to use only HTTPS.
https.hsts.activebooleanrequiredhttps.hsts.max_ageintegerrequiredHow long browsers remember it, in seconds.
https.hsts.include_subdomainsbooleanrequiredhttps.hsts.preloadbooleanrequiredalternative_hostnameobject | nullrequiredA second name under vhost.manitu.de that shows the same - e.g. before a domain transfer or while DNS is not there yet. Null for an alias.
alternative_hostname.activebooleanrequiredalternative_hostname.fqdnstring | nullrequiredThe name, e.g. 1a2b3c4d.vhost.manitu.de - null while not active. A new one each time it is switched on.
alternative_hostname.noindexbooleanrequiredSearch engines are asked not to index it under this name.
alias_listarray of string | nullrequiredIts aliases (fqdn) - null for an alias.
certificateobject | nullrequiredIts SSL certificate - null if none.
certificate.typestringrequiredcertificate.statusstringrequiredpending: asked for, usually issued within an hour; error: could not be issued - often the name does not point to manitu yet.
certificate.expires_atstring | nullrequiredWhen it runs out (the same as manitu_webhosting_web_certificate_get) - Let's Encrypt renews in time; null while pending.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
created_atstring | nullrequiredmoved_alias_listarray of stringrequiredThe aliases it had as a website - they belong to its new website (alias.of) now.
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 website from manitu_webhosting_web_vhost_list, e.g. shop.example.de. Never guess one.
tostringrequiredwebsite or alias.
alias_ofstringFor to alias - required then: the website (or websitebuilder) it belongs to, by fqdn from manitu_webhosting_web_vhost_list. Not an alias, not itself.
redirect_to_parentbooleanFor to alias: redirect visitors to that website's name (HTTP 301, default true); false: show the same under its own name.
Response in data; the rest of the body as on every call
fqdnstringrequiredThe name, e.g. www.example.de - a domain or subdomain of the package; what the other tools take. Unicode for an internationalized domain.
fqdn_asciistringrequiredThe same name as DNS has it (xn--... for an internationalized domain).
typestringrequiredwebsite (the customer's files from a folder, or a redirect to a URL), websitebuilder (made with manitu's website builder) or alias (a further name of a website - see alias).
statusstringrequiredinactive: switched off, the files are kept - visitors get when_inactive.
when_inactiveobjectrequiredWhat visitors get while it is inactive.
when_inactive.responsestringrequiredAn HTTP status (403, 404, 503 - 503 tells search engines to come back), hide (as if there were no website) or page (a page of manitu's, see page).
when_inactive.pagestring | nullrequiredWhich page, for response page: disabled, underconstruction or maintenance.
websiteobject | nullrequiredFor type website, else null.
website.target_dirstring | nullrequiredThe folder shown, relative to the web root, e.g. /htdocs/www.example.com/ (the older layout: /web/...) - see manitu_webhosting_web_structure_get; null when it redirects.
website.redirect_urlstring | nullrequiredThe URL every visitor is sent to - null when it shows a folder.
website.allow_wordpress_xmlrpcbooleanrequiredWordPress' XML-RPC interface reachable - off by default, a frequent target of brute force attacks that manitu's firewall cannot block.
websitebuilderobject | nullrequiredFor type websitebuilder, else null. The editor opens with manitu_webhosting_web_vhost_websitebuilder_get.
websitebuilder.target_dirstringrequiredThe folder manitu set for it - not to be changed.
aliasobject | nullrequiredFor type alias, else null. An alias shows what its website shows, with its HTTPS settings; status, certificate and description are its own.
alias.ofstring | nullrequiredThe website it belongs to (fqdn) - null only for an old alias that lost it.
alias.redirect_to_parentbooleanrequiredVisitors are redirected to the website's name (HTTP 301); false: the alias shows the same under its own name.
httpsobject | nullrequiredFor a website or websitebuilder; null for an alias (its website's apply).
https.redirectbooleanrequiredVisitors coming with http:// are sent to https://.
https.hstsobjectrequiredHSTS (Strict-Transport-Security): browsers remember to use only HTTPS.
https.hsts.activebooleanrequiredhttps.hsts.max_ageintegerrequiredHow long browsers remember it, in seconds.
https.hsts.include_subdomainsbooleanrequiredhttps.hsts.preloadbooleanrequiredalternative_hostnameobject | nullrequiredA second name under vhost.manitu.de that shows the same - e.g. before a domain transfer or while DNS is not there yet. Null for an alias.
alternative_hostname.activebooleanrequiredalternative_hostname.fqdnstring | nullrequiredThe name, e.g. 1a2b3c4d.vhost.manitu.de - null while not active. A new one each time it is switched on.
alternative_hostname.noindexbooleanrequiredSearch engines are asked not to index it under this name.
alias_listarray of string | nullrequiredIts aliases (fqdn) - null for an alias.
certificateobject | nullrequiredIts SSL certificate - null if none.
certificate.typestringrequiredcertificate.statusstringrequiredpending: asked for, usually issued within an hour; error: could not be issued - often the name does not point to manitu yet.
certificate.expires_atstring | nullrequiredWhen it runs out (the same as manitu_webhosting_web_certificate_get) - Let's Encrypt renews in time; null while pending.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
created_atstring | nullrequiredmoved_alias_listarray of stringrequiredThe aliases it had as a website - they belong to its new website (alias.of) now.
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.