Show how to connect to a web hosting package
Host, protocols and ports for FTP, SSH and mail programs of one web hosting package.
manitu_webhosting_connection_get on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Returns how to connect to a web hosting package of the manitu customer account this connection works in, by its site_id from manitu_webhosting_list - for "how do I connect?", "what do I enter in my mail program / FTP program?": ftp (host, protocols with ports - SFTP on port 23, not 22), ssh (host, port, key login only, host key fingerprints) and mail (the server for mail programs - IMAP, POP3, SMTP - with ports and security; NOT the MX server). The user name is each user's own: FTP and SSH users from their list tools, for mail the full address of the mailbox. Passwords are never shown.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
Result structuredContent, checked against the schema
ftpobject | nullrequiredFTP - null if the package has no web part.
ftp.hoststring | nullrequiredThe host to connect to - the web server of the package.
ftp.method_listarray of objectrequiredThe ways to connect, the one to prefer first. SFTP is on port 23, NOT 22; implicit FTPS is not offered; plain FTP (unencrypted) only if nothing else works.
ftp.method_list[].protocolstringrequiredsftp (SSH file transfer), ftps_explicit (FTP with explicit TLS, AUTH TLS), ftp (unencrypted).
ftp.method_list[].portintegerrequiredftp.method_list[].is_encryptedbooleanrequiredftp.method_list[].is_recommendedbooleanrequiredftp.web_ftp_urlstringrequiredFTP in the browser, with the same user name and password.
sshobject | nullrequiredSSH - null if the package has no web part.
ssh.hoststring | nullrequiredThe host to connect to - the web server of the package.
ssh.method_listarray of objectrequiredThe ways to connect: SSH on port 22.
ssh.method_list[].protocolstringrequiredssh.method_list[].portintegerrequiredssh.method_list[].is_encryptedbooleanrequiredssh.method_list[].is_recommendedbooleanrequiredssh.authstringrequiredpublic_key_only: log in with a key from the user's ssh_key_list - a password does not work.
ssh.host_key_listarray of objectrequiredThe server's host keys - on the first connection the SSH client shows one of these fingerprints; it must match.
ssh.host_key_list[].algorithmstringrequiredssh.host_key_list[].fingerprint_sha256stringrequiredAs the SSH client shows it, e.g. "SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8".
mailobject | nullrequiredMail programs - null if the package has no mail part.
mail.hoststringrequiredThe server a mail program connects to - for receiving (IMAP, POP3) and sending (SMTP) alike. NOT the MX server of the package.
mail.method_listarray of objectrequiredThe ways to connect, per protocol the one to prefer first - encrypted only, there is no unencrypted way. Receiving: IMAP (mail stays on the server, several devices) or POP3 (mail is fetched); sending: SMTP with login (the same user name and password) - port 587 with STARTTLS where 465 is blocked.
mail.method_list[].protocolstringrequiredmail.method_list[].portintegerrequiredmail.method_list[].securitystringrequiredssl_tls: encrypted from the start (often "SSL/TLS"); starttls: switched to encryption after connecting ("STARTTLS").
mail.method_list[].is_recommendedbooleanrequiredAuthentication
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.
Response in data; the rest of the body as on every call
ftpobject | nullrequiredFTP - null if the package has no web part.
ftp.hoststring | nullrequiredThe host to connect to - the web server of the package.
ftp.method_listarray of objectrequiredThe ways to connect, the one to prefer first. SFTP is on port 23, NOT 22; implicit FTPS is not offered; plain FTP (unencrypted) only if nothing else works.
ftp.method_list[].protocolstringrequiredsftp (SSH file transfer), ftps_explicit (FTP with explicit TLS, AUTH TLS), ftp (unencrypted).
ftp.method_list[].portintegerrequiredftp.method_list[].is_encryptedbooleanrequiredftp.method_list[].is_recommendedbooleanrequiredftp.web_ftp_urlstringrequiredFTP in the browser, with the same user name and password.
sshobject | nullrequiredSSH - null if the package has no web part.
ssh.hoststring | nullrequiredThe host to connect to - the web server of the package.
ssh.method_listarray of objectrequiredThe ways to connect: SSH on port 22.
ssh.method_list[].protocolstringrequiredssh.method_list[].portintegerrequiredssh.method_list[].is_encryptedbooleanrequiredssh.method_list[].is_recommendedbooleanrequiredssh.authstringrequiredpublic_key_only: log in with a key from the user's ssh_key_list - a password does not work.
ssh.host_key_listarray of objectrequiredThe server's host keys - on the first connection the SSH client shows one of these fingerprints; it must match.
ssh.host_key_list[].algorithmstringrequiredssh.host_key_list[].fingerprint_sha256stringrequiredAs the SSH client shows it, e.g. "SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8".
mailobject | nullrequiredMail programs - null if the package has no mail part.
mail.hoststringrequiredThe server a mail program connects to - for receiving (IMAP, POP3) and sending (SMTP) alike. NOT the MX server of the package.
mail.method_listarray of objectrequiredThe ways to connect, per protocol the one to prefer first - encrypted only, there is no unencrypted way. Receiving: IMAP (mail stays on the server, several devices) or POP3 (mail is fetched); sending: SMTP with login (the same user name and password) - port 587 with STARTTLS where 465 is blocked.
mail.method_list[].protocolstringrequiredmail.method_list[].portintegerrequiredmail.method_list[].securitystringrequiredssl_tls: encrypted from the start (often "SSL/TLS"); starttls: switched to encryption after connecting ("STARTTLS").
mail.method_list[].is_recommendedbooleanrequiredStatuses
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.