API
Get an API keyTry it

Change website of a web hosting package

Change what a website (vHost) shows, its HTTPS settings, certificate, status or description.

WWriteIdempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_web_vhost_seton https://mcp.manitu.de/mcp
POST
/v1/webhosting/web/vhost/seton https://api.manitu.de
Try it
Changes the account. Agents say what will happen and wait for an explicit yes before calling it.

Annotations as tools/list sends them

readOnlyHint falsedestructiveHint falseidempotentHint trueopenWorldHint false

Description for the model

Changes 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. Only the fields given change; the type never does (manitu_webhosting_web_vhost_convert does). website only for type website (another folder or a redirect URL), alias only for an alias (another website, the redirect to it); https and alternative_hostname not for an alias - it has its website's. status inactive switches it off (e.g. for maintenance) - visitors get when_inactive, the files are kept. certificate none removes the certificate. Changes take up to an hour everywhere. Refused with a conflict for an alias that lost its website (alias_without_website - give alias.of) or when the package cannot be changed now (not_configurable). Tell the customer what will change and ask for an explicit yes first.

Arguments

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

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

The website from manitu_webhosting_web_vhost_list, e.g. www.example.de. Never guess one.

min length 3max length 253
websiteobject

Only for type website: what it shows.

website.target_dirstring

Show this folder, relative to the web root - for a new website its own folder in htdocs, website_folder_template.api of manitu_webhosting_web_structure_get (e.g. /htdocs/www.example.com/; the older layout: /web/www.example.com/). Not together with redirect_url.

min length 1max length 255
website.redirect_urlstring

Instead of a folder: send every visitor to this URL, e.g. https://www.example.com/ - https:// is put in front when there is no scheme.

min length 1max length 255
website.create_target_dirboolean

Create target_dir if it is not there (default true); false: it must be there.

website.allow_wordpress_xmlrpcboolean

Make WordPress' XML-RPC interface reachable - only if the customer needs it: a frequent target of brute force attacks that manitu's firewall cannot block. Tell him so.

aliasobject

Only for type alias.

alias.ofstring

The website (or websitebuilder) it belongs to, by fqdn from manitu_webhosting_web_vhost_list. Not an alias.

min length 3max length 253
alias.redirect_to_parentboolean

Redirect visitors to the website's name (HTTP 301); false: show the same under the alias' own name.

httpsobject

Not for an alias (it has its website's). Change HSTS only if the customer knows what it means: browsers keep using HTTPS only for max_age seconds, even if the certificate is gone.

https.redirectboolean

Send http:// visitors to https://.

https.hstsobject

HSTS (Strict-Transport-Security).

https.hsts.activeboolean
https.hsts.max_ageinteger

Seconds, 300 (5 minutes) to 63072000 (2 years).

min 300max 63072000
https.hsts.include_subdomainsboolean
https.hsts.preloadboolean

Usually not recommended - needs max_age of at least 31536000 and include_subdomains.

alternative_hostnameobject

Not for an alias: a second name under vhost.manitu.de that shows the same.

alternative_hostname.activeboolean

Switched off and on again, it gets a new name.

alternative_hostname.noindexboolean

Ask search engines not to index it under this name.

certificatestring

letsencrypt (free, added and renewed by manitu) or none (rarely wanted). Let's Encrypt needs the domain at manitu (not while a transfer is pending) and an active website; it is usually there within an hour. A custom certificate is uploaded in the customer panel - here it is only kept.

One of letsencrypt none
statusstring

inactive: switch it off (e.g. for maintenance) - the files are kept, visitors get when_inactive; no Let's Encrypt certificate is renewed meanwhile.

One of active inactive
when_inactiveobject

What visitors get while it is inactive.

when_inactive.responsestring

http_status_403, http_status_404, http_status_503 (tells search engines to come back), hide (as if there were no website) or page (one of manitu's, see page).

One of http_status_403 http_status_404 http_status_503 hide page
when_inactive.pagestring

For response page: disabled, underconstruction or maintenance. The customer's duties (imprint, privacy information) stay his.

One of disabled underconstruction maintenance
descriptionstring | null

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

max length 1024

Result structuredContent, checked against the schema

fqdnstringrequired

The name, e.g. www.example.de - a domain or subdomain of the package; what the other tools take. Unicode for an internationalized domain.

fqdn_asciistringrequired

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

typestringrequired

website (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).

One of website websitebuilder alias
statusstringrequired

inactive: switched off, the files are kept - visitors get when_inactive.

One of active inactive
when_inactiveobjectrequired

What visitors get while it is inactive.

when_inactive.responsestringrequired

An 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).

One of http_status_403 http_status_404 http_status_503 hide page
when_inactive.pagestring | nullrequired

Which page, for response page: disabled, underconstruction or maintenance.

One of disabled underconstruction maintenance null
websiteobject | nullrequired

For type website, else null.

website.target_dirstring | nullrequired

The 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 | nullrequired

The URL every visitor is sent to - null when it shows a folder.

website.allow_wordpress_xmlrpcbooleanrequired

WordPress' XML-RPC interface reachable - off by default, a frequent target of brute force attacks that manitu's firewall cannot block.

websitebuilderobject | nullrequired

For type websitebuilder, else null. The editor opens with manitu_webhosting_web_vhost_websitebuilder_get.

websitebuilder.target_dirstringrequired

The folder manitu set for it - not to be changed.

aliasobject | nullrequired

For type alias, else null. An alias shows what its website shows, with its HTTPS settings; status, certificate and description are its own.

alias.ofstring | nullrequired

The website it belongs to (fqdn) - null only for an old alias that lost it.

alias.redirect_to_parentbooleanrequired

Visitors are redirected to the website's name (HTTP 301); false: the alias shows the same under its own name.

httpsobject | nullrequired

For a website or websitebuilder; null for an alias (its website's apply).

https.redirectbooleanrequired

Visitors coming with http:// are sent to https://.

https.hstsobjectrequired

HSTS (Strict-Transport-Security): browsers remember to use only HTTPS.

https.hsts.activebooleanrequired
https.hsts.max_ageintegerrequired

How long browsers remember it, in seconds.

https.hsts.include_subdomainsbooleanrequired
https.hsts.preloadbooleanrequired
alternative_hostnameobject | nullrequired

A 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.activebooleanrequired
alternative_hostname.fqdnstring | nullrequired

The name, e.g. 1a2b3c4d.vhost.manitu.de - null while not active. A new one each time it is switched on.

alternative_hostname.noindexbooleanrequired

Search engines are asked not to index it under this name.

alias_listarray of string | nullrequired

Its aliases (fqdn) - null for an alias.

certificateobject | nullrequired

Its SSL certificate - null if none.

certificate.typestringrequired
One of letsencrypt custom
certificate.statusstringrequired

pending: asked for, usually issued within an hour; error: could not be issued - often the name does not point to manitu yet.

One of active pending error expired
certificate.expires_atstring | nullrequired

When it runs out (the same as manitu_webhosting_web_certificate_get) - Let's Encrypt renews in time; null while pending.

Format date-time
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

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 | stringrequired

The site_id from manitu_webhosting_list - never guess one.

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

The website from manitu_webhosting_web_vhost_list, e.g. www.example.de. Never guess one.

min length 3max length 253
websiteobject

Only for type website: what it shows.

website.target_dirstring

Show this folder, relative to the web root - for a new website its own folder in htdocs, website_folder_template.api of manitu_webhosting_web_structure_get (e.g. /htdocs/www.example.com/; the older layout: /web/www.example.com/). Not together with redirect_url.

min length 1max length 255
website.redirect_urlstring

Instead of a folder: send every visitor to this URL, e.g. https://www.example.com/ - https:// is put in front when there is no scheme.

min length 1max length 255
website.create_target_dirboolean

Create target_dir if it is not there (default true); false: it must be there.

website.allow_wordpress_xmlrpcboolean

Make WordPress' XML-RPC interface reachable - only if the customer needs it: a frequent target of brute force attacks that manitu's firewall cannot block. Tell him so.

aliasobject

Only for type alias.

alias.ofstring

The website (or websitebuilder) it belongs to, by fqdn from manitu_webhosting_web_vhost_list. Not an alias.

min length 3max length 253
alias.redirect_to_parentboolean

Redirect visitors to the website's name (HTTP 301); false: show the same under the alias' own name.

httpsobject

Not for an alias (it has its website's). Change HSTS only if the customer knows what it means: browsers keep using HTTPS only for max_age seconds, even if the certificate is gone.

https.redirectboolean

Send http:// visitors to https://.

https.hstsobject

HSTS (Strict-Transport-Security).

https.hsts.activeboolean
https.hsts.max_ageinteger

Seconds, 300 (5 minutes) to 63072000 (2 years).

min 300max 63072000
https.hsts.include_subdomainsboolean
https.hsts.preloadboolean

Usually not recommended - needs max_age of at least 31536000 and include_subdomains.

alternative_hostnameobject

Not for an alias: a second name under vhost.manitu.de that shows the same.

alternative_hostname.activeboolean

Switched off and on again, it gets a new name.

alternative_hostname.noindexboolean

Ask search engines not to index it under this name.

certificatestring

letsencrypt (free, added and renewed by manitu) or none (rarely wanted). Let's Encrypt needs the domain at manitu (not while a transfer is pending) and an active website; it is usually there within an hour. A custom certificate is uploaded in the customer panel - here it is only kept.

One of letsencrypt none
statusstring

inactive: switch it off (e.g. for maintenance) - the files are kept, visitors get when_inactive; no Let's Encrypt certificate is renewed meanwhile.

One of active inactive
when_inactiveobject

What visitors get while it is inactive.

when_inactive.responsestring

http_status_403, http_status_404, http_status_503 (tells search engines to come back), hide (as if there were no website) or page (one of manitu's, see page).

One of http_status_403 http_status_404 http_status_503 hide page
when_inactive.pagestring

For response page: disabled, underconstruction or maintenance. The customer's duties (imprint, privacy information) stay his.

One of disabled underconstruction maintenance
descriptionstring | null

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

max length 1024

Response in data; the rest of the body as on every call

fqdnstringrequired

The name, e.g. www.example.de - a domain or subdomain of the package; what the other tools take. Unicode for an internationalized domain.

fqdn_asciistringrequired

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

typestringrequired

website (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).

One of website websitebuilder alias
statusstringrequired

inactive: switched off, the files are kept - visitors get when_inactive.

One of active inactive
when_inactiveobjectrequired

What visitors get while it is inactive.

when_inactive.responsestringrequired

An 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).

One of http_status_403 http_status_404 http_status_503 hide page
when_inactive.pagestring | nullrequired

Which page, for response page: disabled, underconstruction or maintenance.

One of disabled underconstruction maintenance null
websiteobject | nullrequired

For type website, else null.

website.target_dirstring | nullrequired

The 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 | nullrequired

The URL every visitor is sent to - null when it shows a folder.

website.allow_wordpress_xmlrpcbooleanrequired

WordPress' XML-RPC interface reachable - off by default, a frequent target of brute force attacks that manitu's firewall cannot block.

websitebuilderobject | nullrequired

For type websitebuilder, else null. The editor opens with manitu_webhosting_web_vhost_websitebuilder_get.

websitebuilder.target_dirstringrequired

The folder manitu set for it - not to be changed.

aliasobject | nullrequired

For type alias, else null. An alias shows what its website shows, with its HTTPS settings; status, certificate and description are its own.

alias.ofstring | nullrequired

The website it belongs to (fqdn) - null only for an old alias that lost it.

alias.redirect_to_parentbooleanrequired

Visitors are redirected to the website's name (HTTP 301); false: the alias shows the same under its own name.

httpsobject | nullrequired

For a website or websitebuilder; null for an alias (its website's apply).

https.redirectbooleanrequired

Visitors coming with http:// are sent to https://.

https.hstsobjectrequired

HSTS (Strict-Transport-Security): browsers remember to use only HTTPS.

https.hsts.activebooleanrequired
https.hsts.max_ageintegerrequired

How long browsers remember it, in seconds.

https.hsts.include_subdomainsbooleanrequired
https.hsts.preloadbooleanrequired
alternative_hostnameobject | nullrequired

A 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.activebooleanrequired
alternative_hostname.fqdnstring | nullrequired

The name, e.g. 1a2b3c4d.vhost.manitu.de - null while not active. A new one each time it is switched on.

alternative_hostname.noindexbooleanrequired

Search engines are asked not to index it under this name.

alias_listarray of string | nullrequired

Its aliases (fqdn) - null for an alias.

certificateobject | nullrequired

Its SSL certificate - null if none.

certificate.typestringrequired
One of letsencrypt custom
certificate.statusstringrequired

pending: asked for, usually issued within an hour; error: could not be issued - often the name does not point to manitu yet.

One of active pending error expired
certificate.expires_atstring | nullrequired

When it runs out (the same as manitu_webhosting_web_certificate_get) - Let's Encrypt renews in time; null while pending.

Format date-time
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

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.