API: FTP-server

From BrainyCP
Jump to: navigation, search

Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.

Incoming data marked with an asterisk are required.

Module

Function

Incoming data

Error variants

ftp

Add FTP-account.

addftp

username (post)* — Username;

password (post)* — User password;

ftp (post)* — constant, module name;

addftp (post)* — constant, operation type;

ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');

ftp_pass (post)* —password ftp:

ftp_user_quota (post)* — quota;

ftp_user_dir (post)* — directory ftp  (relative to home directory);

language (post) — can take a value: en/ru (by default ru);

panel_user (post) -  ISP username, to which the operation is applied.

error:0, mess:'New FTP user has been added ';

error:1, mess:'This FTP user already exists';

error:2, mess:'No available FTP servers';

error:3, mess:'System user name is missing';

error:4, mess:'There was an error while adding a new user';

error:5, mess:'Error in parameters';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'This user doesn't exist in ISP-panel:<user>'.

ftp

Delete FTP-account.

delftp

username (post)* — Username;

password (post)* — User password;

ftp (post)* — constant, module name;

delftp (post)* — constant, operation type;

ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');

ftp_deldir_val (post) — delete the user together with their catalog - "yes/no" (by default 'no');

language (post) —can take a value: en/ru (by default ru);

panel_user (post) — ISP username, to which the operation is applied.

error:0, mess:'New FTP user has been successfully removed <name>';

error:1, mess:'The FTP user is not found' <name>';

error:2, mess:'No installed FTP servers found';

error:3, mess:'Error while deleting an FTP user: <name>';

error:5, mess:'Error in parameters block';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'This user is not found in ISP-panel:<user>'.

ftp

Change the quota of current FTP-account.

quotaftp

username (post)* — Username;

password (post)* — User password;

ftp (post)* — constant, module name;

quotaftp (post)* — constant, operation type;

ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');

quota (post)* — new quota in Mb;

language (post) —can take a value: en/ru (by default ru);

panel_user (post) — ISP username, to which the operation is applied.

error:0, mess:'Quota for FTP user has been changed successfully: <name>';

error:1, mess:'The FTP user is not found' <name>';

error:2, mess:'No installed FTP servers found';

error:3, mess:'Error in changing quota for  FTP: <name>'. error_info: more info about the error;

error:5, mess:'Error in parameters block';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'This user is not found in ISP-panel:<user>'.

ftp

Change password for current FTP-account.

passftp

username (post)* — Username;

password (post)* — User password;

ftp (post)* — constant, module name;

passftp (post)* — constant, operation type;

ftp_login (post)* — login ftp;

ftp_pass (post)* — new password for FTP client (not less than 7 symbols);

language (post) — can take a value: en/ru (by default ru);

 

error:0, mess:'Password for FTP user has been changed: <name>';

error:1, mess:'FTP user is not found' <name>'

error:2, mess:'No installed FTP servers found'

error:3, mess:'Error in changing FTP quota: <name>'. error_info: more info about the error;

error:5, mess:'Error in parameters block';

error:1000, mess:'You don't have admin rights';

error:1001, mess:'The user is not found in ISP-panel:<user>'.

ftp

List of FTP-accounts for a definite user.

accountuserftp

username (post)* — Username;

password (post)* — User password;

ftp (post)* — constant, module name;

accountuserftp (post)* — constant, operation type;

language (post) — can take a value: en/ru (by default ru);

panel_user (post) — ISP username, to which the operation is applied.

error:0, mess:'The FTP user list has been received for: <name>';

error:2, mess:'No installed FTP servers'

error:3, mess:'Error in changing quota for  FTP: <name>'. error_info: more info about error;

error:5, mess:'Ошибка в блоке параметров';

error:1000, mess:'You don't have admin rights;

error:1001, mess:'The user is not found in ISP-panel:<user>'.

Other useful articles:

API: подключение

API: мониторинг

API: статус веб-сервера

API: автоустановщик CMS

API: настройка бекапов

API: трансфер между серверами

API: антивирус

API: настройки сервера

API: управление веб-сервером

API: базы данных

API: пользовательские сертификаты

API: управление почтовыми ящиками

API: информация о сервере

API: почта

API: управление DNS-зонами

API: использование трафика

API: почтовые ящики клиента

API: установка веб-сервера

API: логирование

API: сервер имен

API: хост-аккаунты

API: менеджер приложений

API: сертификаты сервисов

API: CRON

API: менеджер процессов

API: сетевые инструменты

API: FTP-сервер

API: менеджер IP-адресов

API: средняя нагрузка

API: MySQL processlist