Show website of a web hosting package

One website (vHost) of a web hosting package: what it shows, HTTPS, certificate, status.

RReadIdempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_web_vhost_geton https://mcp.manitu.de/mcp
POST
/v1/webhosting/web/vhost/geton https://api.manitu.de
Try it
readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

Returns one 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: its type, what it shows (folder or redirect), the website of an alias and the aliases of a website, HTTPS and HSTS, the certificate, the alternative hostname, its status and description.

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

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 website from manitu_webhosting_web_vhost_list, e.g. www.example.de. Never guess one.

min length 3max length 253
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
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.