List FTP users of a web hosting package
The FTP users of one web hosting package, with how to connect.
manitu_webhosting_web_ftpuser_list on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Lists the FTP users of a web hosting package of the manitu customer account this connection works in, by its site_id from manitu_webhosting_list: for each its username (what the customer logs in with), description, status, whether it can log in now, when it expires, its directory, disk space limit, and whether its password should be renewed. connection says how to connect - host, and the protocols with their ports (SFTP on port 23, not 22) - give it when the customer sets up an FTP program. count_max is how many FTP users the package allows.
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
Result structuredContent, checked against the schema
ftp_user_listarray of objectrequiredftp_user_list[].usernamestringrequiredThe user name to log in with (ftp<number>) - what the other FTP user tools take.
ftp_user_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
ftp_user_list[].statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
ftp_user_list[].is_usable_nowbooleanrequiredIt can log in right now: active and not expired.
ftp_user_list[].expires_atstring | nullrequiredWhen the FTP user expires. From this moment on it can no longer be used (the moment itself is excluded); null: without end.
ftp_user_list[].home_dirstring | nullrequiredThe directory it starts in and cannot leave, relative to the package (/ = the whole package).
ftp_user_list[].quota_mbinteger | nullrequiredDisk space in MB the files it owns may take; null: no limit of its own (the package's applies).
ftp_user_list[].password_change_recommendedbooleanrequiredThe password is kept in an outdated form - the customer should set a new one.
ftp_user_list[].created_atstring | nullrequiredWhen it was created.
ftp_user_list[].last_login_atstring | nullrequiredIts last login, null if never.
count_maxinteger | nullrequiredHow many FTP users the package allows.
connectionobjectrequiredconnection.hoststring | nullrequiredThe host to connect to - the web server of the package.
connection.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.
connection.method_list[].protocolstringrequiredsftp (SSH file transfer), ftps_explicit (FTP with explicit TLS, AUTH TLS), ftp (unencrypted).
connection.method_list[].portintegerrequiredconnection.method_list[].is_encryptedbooleanrequiredconnection.method_list[].is_recommendedbooleanrequiredconnection.web_ftp_urlstringrequiredFTP in the browser, with the same user name and password.
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.
Response in data; the rest of the body as on every call
ftp_user_listarray of objectrequiredftp_user_list[].usernamestringrequiredThe user name to log in with (ftp<number>) - what the other FTP user tools take.
ftp_user_list[].descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
ftp_user_list[].statusstringrequiredactive, or inactive (switched off by the customer, kept for later).
ftp_user_list[].is_usable_nowbooleanrequiredIt can log in right now: active and not expired.
ftp_user_list[].expires_atstring | nullrequiredWhen the FTP user expires. From this moment on it can no longer be used (the moment itself is excluded); null: without end.
ftp_user_list[].home_dirstring | nullrequiredThe directory it starts in and cannot leave, relative to the package (/ = the whole package).
ftp_user_list[].quota_mbinteger | nullrequiredDisk space in MB the files it owns may take; null: no limit of its own (the package's applies).
ftp_user_list[].password_change_recommendedbooleanrequiredThe password is kept in an outdated form - the customer should set a new one.
ftp_user_list[].created_atstring | nullrequiredWhen it was created.
ftp_user_list[].last_login_atstring | nullrequiredIts last login, null if never.
count_maxinteger | nullrequiredHow many FTP users the package allows.
connectionobjectrequiredconnection.hoststring | nullrequiredThe host to connect to - the web server of the package.
connection.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.
connection.method_list[].protocolstringrequiredsftp (SSH file transfer), ftps_explicit (FTP with explicit TLS, AUTH TLS), ftp (unencrypted).
connection.method_list[].portintegerrequiredconnection.method_list[].is_encryptedbooleanrequiredconnection.method_list[].is_recommendedbooleanrequiredconnection.web_ftp_urlstringrequiredFTP in the browser, with the same user name and password.
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.