List FTP users of a web hosting package

The FTP users of one web hosting package, with how to connect.

RReadIdempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_web_ftpuser_liston https://mcp.manitu.de/mcp
POST
/v1/webhosting/web/ftpuser/liston https://api.manitu.de
Try it
readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

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.

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

pattern ^[1-9][0-9]*$min 1
ftp_user_listarray of objectrequired
ftp_user_list[].usernamestringrequired

The user name to log in with (ftp<number>) - what the other FTP user tools take.

ftp_user_list[].descriptionstring | nullrequired

What the customer wrote about it (his description), null if nothing - not its name or user name.

ftp_user_list[].statusstringrequired

active, or inactive (switched off by the customer, kept for later).

One of active inactive
ftp_user_list[].is_usable_nowbooleanrequired

It can log in right now: active and not expired.

ftp_user_list[].expires_atstring | nullrequired

When the FTP user expires. From this moment on it can no longer be used (the moment itself is excluded); null: without end.

Format date-time
ftp_user_list[].home_dirstring | nullrequired

The directory it starts in and cannot leave, relative to the package (/ = the whole package).

ftp_user_list[].quota_mbinteger | nullrequired

Disk space in MB the files it owns may take; null: no limit of its own (the package's applies).

ftp_user_list[].password_change_recommendedbooleanrequired

The password is kept in an outdated form - the customer should set a new one.

ftp_user_list[].created_atstring | nullrequired

When it was created.

Format date-time
ftp_user_list[].last_login_atstring | nullrequired

Its last login, null if never.

Format date-time
count_maxinteger | nullrequired

How many FTP users the package allows.

connectionobjectrequired
connection.hoststring | nullrequired

The host to connect to - the web server of the package.

connection.method_listarray of objectrequired

The 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[].protocolstringrequired

sftp (SSH file transfer), ftps_explicit (FTP with explicit TLS, AUTH TLS), ftp (unencrypted).

One of sftp ftps_explicit ftp
connection.method_list[].portintegerrequired
connection.method_list[].is_encryptedbooleanrequired
connection.method_list[].is_recommendedbooleanrequired
connection.web_ftp_urlstringrequired

FTP in the browser, with the same user name and password.

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
ftp_user_listarray of objectrequired
ftp_user_list[].usernamestringrequired

The user name to log in with (ftp<number>) - what the other FTP user tools take.

ftp_user_list[].descriptionstring | nullrequired

What the customer wrote about it (his description), null if nothing - not its name or user name.

ftp_user_list[].statusstringrequired

active, or inactive (switched off by the customer, kept for later).

One of active inactive
ftp_user_list[].is_usable_nowbooleanrequired

It can log in right now: active and not expired.

ftp_user_list[].expires_atstring | nullrequired

When the FTP user expires. From this moment on it can no longer be used (the moment itself is excluded); null: without end.

Format date-time
ftp_user_list[].home_dirstring | nullrequired

The directory it starts in and cannot leave, relative to the package (/ = the whole package).

ftp_user_list[].quota_mbinteger | nullrequired

Disk space in MB the files it owns may take; null: no limit of its own (the package's applies).

ftp_user_list[].password_change_recommendedbooleanrequired

The password is kept in an outdated form - the customer should set a new one.

ftp_user_list[].created_atstring | nullrequired

When it was created.

Format date-time
ftp_user_list[].last_login_atstring | nullrequired

Its last login, null if never.

Format date-time
count_maxinteger | nullrequired

How many FTP users the package allows.

connectionobjectrequired
connection.hoststring | nullrequired

The host to connect to - the web server of the package.

connection.method_listarray of objectrequired

The 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[].protocolstringrequired

sftp (SSH file transfer), ftps_explicit (FTP with explicit TLS, AUTH TLS), ftp (unencrypted).

One of sftp ftps_explicit ftp
connection.method_list[].portintegerrequired
connection.method_list[].is_encryptedbooleanrequired
connection.method_list[].is_recommendedbooleanrequired
connection.web_ftp_urlstringrequired

FTP in the browser, with the same user name and password.

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.