Difference between revisions of "API: FTP-server"

From BrainyCP
Jump to: navigation, search
m (Fgsfds переименовал страницу API: FTP-сервер в API: FTP-server)
Line 1: Line 1:
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
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.
  
 
{| border="1" cellpadding="5"
 
{| border="1" cellpadding="5"
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Module'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p>  
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 15: Line 15:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Добавить FTP-аккаунт.
+
Add FTP-account.
  
 
addftp
 
addftp
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
ftp (post)* — константа, имя модуля;
+
ftp (post)* — constant, module name;
  
−
addftp (post)* — константа, тип операции;
+
addftp (post)* — constant, operation type;
  
−
ftp_login (post)* — логин ftp (конечный будет иметь вид:'<имя пользователя системы>_<ftp_login>');
+
ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');
  
−
ftp_pass (post)* — пароль ftp:
+
ftp_pass (post)* —password ftp:
  
−
ftp_user_quota (post)* — квота;
+
ftp_user_quota (post)* — quota;
  
−
ftp_user_dir (post)* — директория ftp &nbsp;(относительно домашнего каталога);
+
ftp_user_dir (post)* — directory ftp &nbsp;(relative to home directory);
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) — can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) -&nbsp;&nbsp;ISP username, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Новый пользователь FTP был успешно добавлен';
+
error:0, mess:'New FTP user has been added ';
  
−
error:1, mess:'Такой пользователь FTP уже существует';
+
error:1, mess:'This FTP user already exists';
  
−
error:2, mess:'Нет доступных FTP серверов';
+
error:2, mess:'No available FTP servers';
  
−
error:3, mess:'Отсутствует имя пользователя системы';
+
error:3, mess:'System user name is missing';
  
−
error:4, mess:'Произошла ошибка при добавлении нового пользователя';
+
error:4, mess:'There was an error while adding a new user';
  
−
error:5, mess:'Ошибка в параметрах';
+
error:5, mess:'Error in parameters';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'This user doesn't exist in ISP-panel:<user>'.
  
 
|-
 
|-
Line 62: Line 62:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удалить FTP-аккаунт.
+
Delete FTP-account.
  
 
delftp
 
delftp
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
ftp (post)* — константа, имя модуля;
+
ftp (post)* — constant, module name;
  
−
delftp (post)* — константа, тип операции;
+
delftp (post)* — constant, operation type;
  
−
ftp_login (post)* — логин ftp (конечный будет иметь вид:'<имя пользователя системы>_<ftp_login>');
+
ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');
  
−
ftp_deldir_val (post) — удалять вместе с пользователем и его каталог - "yes/no" (по умолчанию 'no');
+
ftp_deldir_val (post) — delete the user together with their catalog - "yes/no" (by default 'no');
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) —can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) — ISP username, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Новый пользователь FTP был успешно удален <name>';
+
error:0, mess:'New FTP user has been successfully removed <name>';
  
−
error:1, mess:'Указанный пользователь FTP не найден' <name>';
+
error:1, mess:'The FTP user is not found' <name>';
  
−
error:2, mess:'Нет установленных FTP серверов';
+
error:2, mess:'No installed FTP servers found';
  
−
error:3, mess:'Ошибка при удалении FTP пользователя: <name>';
+
error:3, mess:'Error while deleting an FTP user: <name>';
  
−
error:5, mess:'Ошибка в блоке параметров';
+
error:5, mess:'Error in parameters block';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'This user is not found in ISP-panel:<user>'.
  
 
|-
 
|-
Line 103: Line 103:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Сменить квоту существующего FTP-аккаунта.
+
Change the quota of current FTP-account.
  
 
quotaftp
 
quotaftp
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
ftp (post)* — константа, имя модуля;
+
ftp (post)* — constant, module name;
  
−
quotaftp (post)* — константа, тип операции;
+
quotaftp (post)* — constant, operation type;
  
−
ftp_login (post)* — логин ftp (конечный будет иметь вид:'<имя пользователя системы>_<ftp_login>');
+
ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');
  
−
quota (post)* — новая квота в Мб;
+
quota (post)* — new quota in Mb;
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) —can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) — ISP username, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Квота для пользователя FTP была успешно изменена: <name>';
+
error:0, mess:'Quota for FTP user has been changed successfully: <name>';
  
−
error:1, mess:'Указанный пользователь FTP не найден' <name>';
+
error:1, mess:'The FTP user is not found' <name>';
  
−
error:2, mess:'Нет установленных FTP серверов';
+
error:2, mess:'No installed FTP servers found';
  
−
error:3, mess:'Ошибка изменения квоты FTP: <name>'. error_info: расширенная информация об ошибке;
+
error:3, mess:'Error in changing quota for&nbsp; FTP: <name>'. error_info: more info about the error;
  
−
error:5, mess:'Ошибка в блоке параметров';
+
error:5, mess:'Error in parameters block';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'This user is not found in ISP-panel:<user>'.
  
 
|-
 
|-
Line 144: Line 144:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Сменить пароль существующего FTP-аккаунта.
+
Change password for current FTP-account.
  
 
passftp
 
passftp
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
ftp (post)* — константа, имя модуля;
+
ftp (post)* — constant, module name;
  
−
passftp (post)* — константа, тип операции;
+
passftp (post)* — constant, operation type;
  
−
ftp_login (post)* — логин ftp (конечный будет иметь вид:'<имя пользователя системы>_<ftp_login>');
+
ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');
  
−
pass (post)* — новый пароль для FTP клиента (не менее 7 символов);
+
pass (post)* — new password for FTP client (not less than 7 symbols);
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) — can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) — ISP username, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Пароль для пользователя FTP был успешно изменен: <name>';
+
error:0, mess:'Password for FTP user has been changed: <name>';
  
−
error:1, mess:'Указанный пользователь FTP не найден' <name>'
+
error:1, mess:'FTP user is not found' <name>'
  
−
error:2, mess:'Нет установленных FTP серверов'
+
error:2, mess:'No installed FTP servers found'
  
−
error:3, mess:'Ошибка изменения квоты FTP: <name>'. error_info: расширенная информация об ошибке;
+
error:3, mess:'Error in changing FTP quota: <name>'. error_info: more info about the error;
  
−
error:5, mess:'Ошибка в блоке параметров';
+
error:5, mess:'Error in parameters block';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights';
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'The user is not found in ISP-panel:<user>'.
  
 
|-
 
|-
Line 185: Line 185:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Список FTP-аккаунтов конкретного пользователя.
+
List of FTP-accounts for a definite user.
  
 
accountuserftp
 
accountuserftp
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
username (post)* — Username;
  
−
password (post)* — пароль пользователя;
+
password (post)* — User password;
  
−
ftp (post)* — константа, имя модуля;
+
ftp (post)* — constant, module name;
  
−
accountuserftp (post)* — константа, тип операции;
+
accountuserftp (post)* — constant, operation type;
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
language (post) — can take a value: en/ru (by default ru);
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
panel_user (post) — ISP username, to which the operation is applied.
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Список пользователей FTP был успешно получен для: <name>';
+
error:0, mess:'The FTP user list has been received for: <name>';
  
−
error:2, mess:'Нет установленных FTP серверов'
+
error:2, mess:'No installed FTP servers'
  
−
error:3, mess:'Ошибка изменения квоты FTP: <name>'. error_info: расширенная информация об ошибке;
+
error:3, mess:'Error in changing quota for &nbsp;FTP: <name>'. error_info: more info about error;
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
  
−
error:1000, mess:'У вас нет прав администратора';
+
error:1000, mess:'You don't have admin rights;
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
error:1001, mess:'The user is not found in ISP-panel:<user>'.
  
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
 
{| style="width: 1191px;"
 
{| style="width: 1191px;"

Revision as of 22:35, 9 April 2021

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 (end login will look like:'<system user name>_<ftp_login>');

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

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:'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

Retrieved from "https://docs.brainycp.io/index.php?title=API:_FTP-server&oldid=1280"