List web hosting packages
The web hosting packages of the account, a page at a time, optionally filtered by text.
manitu_webhosting_list on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Lists the web hosting packages of the manitu customer account this connection works in: for each its site_id (the key for every other webhosting tool), package name (a domain name - name a package by it; all domains of a package work alike), the customer's description of it if any, status of the contract and plan. total_count says how many there are in all; page with page_token = next_page_token while it is not null. For paths, PHP, disk space and limits of one package use manitu_webhosting_get with its site_id. Packages this access may not see are not listed. The server host names are technical: the web server only matters for SSH/FTP, mail.mx_server is the MX target, not the server for mail programs (IMAP/POP3/SMTP) - do not mention them unless asked.
Arguments
page_sizeintegerHow many entries per page, default 100.
page_tokenstringnext_page_token of the previous page - with the same filters.
text_containsstringOnly packages whose description, package name or site name (site<site_id>) contains this, ignoring case.
Result structuredContent, checked against the schema
webhosting_listarray of objectrequiredwebhosting_list[].site_idintegerrequiredThe web hosting package - what its routes take. Globally unique; on the servers its home is /home/sites/site<site_id>.
webhosting_list[].service_typestringrequiredThe kind of service - its own data is under the key of that name.
webhosting_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
webhosting_list[].statusstring | nullrequiredThe state of the contract, e.g. active, expiring (cancelled, runs out at paid_until).
webhosting_list[].is_configurablebooleanrequiredIt can be changed right now - false e.g. while suspended or being moved.
webhosting_list[].planstring | nullrequiredThe plan, e.g. "Webhosting M".
webhosting_list[].webhostingobjectrequiredwebhosting_list[].webhosting.package_namestring | nullrequiredThe name of the package on contract and invoice - a domain name, but not a special one: all domains of a web hosting package work alike.
webhosting_list[].webhosting.site_namestring | nullrequiredsite<site_id> - how the package is named on the servers (paths, SFTP).
webhosting_list[].webhosting.webobject | nullrequiredThe web part - null if the package has none.
webhosting_list[].webhosting.web.serverstring | nullrequiredThe web server the package runs on (host name) - what SSH and SFTP/FTP connect to. Technical: mention it only for SSH/FTP or when asked.
webhosting_list[].webhosting.mailobject | nullrequiredThe mail part - null if the package has none.
webhosting_list[].webhosting.mail.mx_serverstring | nullrequiredThe server that receives the package's e-mail - the MX target in DNS. NOT the server for mail programs (IMAP, POP3, SMTP): never give it to the customer as his mail server; mention it only when asked about MX.
total_countintegerrequiredHow many entries match, on all pages together.
next_page_tokenstring | nullrequiredPass as page_token for the next page; null on the last.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
page_sizeintegerHow many entries per page, default 100.
page_tokenstringnext_page_token of the previous page - with the same filters.
text_containsstringOnly packages whose description, package name or site name (site<site_id>) contains this, ignoring case.
Response in data; the rest of the body as on every call
webhosting_listarray of objectrequiredwebhosting_list[].site_idintegerrequiredThe web hosting package - what its routes take. Globally unique; on the servers its home is /home/sites/site<site_id>.
webhosting_list[].service_typestringrequiredThe kind of service - its own data is under the key of that name.
webhosting_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
webhosting_list[].statusstring | nullrequiredThe state of the contract, e.g. active, expiring (cancelled, runs out at paid_until).
webhosting_list[].is_configurablebooleanrequiredIt can be changed right now - false e.g. while suspended or being moved.
webhosting_list[].planstring | nullrequiredThe plan, e.g. "Webhosting M".
webhosting_list[].webhostingobjectrequiredwebhosting_list[].webhosting.package_namestring | nullrequiredThe name of the package on contract and invoice - a domain name, but not a special one: all domains of a web hosting package work alike.
webhosting_list[].webhosting.site_namestring | nullrequiredsite<site_id> - how the package is named on the servers (paths, SFTP).
webhosting_list[].webhosting.webobject | nullrequiredThe web part - null if the package has none.
webhosting_list[].webhosting.web.serverstring | nullrequiredThe web server the package runs on (host name) - what SSH and SFTP/FTP connect to. Technical: mention it only for SSH/FTP or when asked.
webhosting_list[].webhosting.mailobject | nullrequiredThe mail part - null if the package has none.
webhosting_list[].webhosting.mail.mx_serverstring | nullrequiredThe server that receives the package's e-mail - the MX target in DNS. NOT the server for mail programs (IMAP, POP3, SMTP): never give it to the customer as his mail server; mention it only when asked about MX.
total_countintegerrequiredHow many entries match, on all pages together.
next_page_tokenstring | nullrequiredPass as page_token for the next page; null on the last.
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.