Difference between revisions of "API: FTP-server"

From BrainyCP
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 157: Line 157:
 
passftp (post)* — constant, operation type;
 
passftp (post)* — constant, operation type;
  
−
ftp_login (post)* — login ftp (end login will look like:'<system user name>_<ftp_login>');
+
ftp_login (post)* — login ftp;
  
−
pass (post)* — new password for FTP client (not less than 7 symbols);
+
ftp_pass&nbsp;(post)* — new password for FTP client (not less than 7 symbols);
  
 
language (post) — can take a value: en/ru (by default ru);
 
language (post) — can take a value: en/ru (by default ru);
  
−
panel_user (post) — ISP username, to which the operation is applied.
+
&nbsp;
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 219: Line 219:
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1271px;"
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 367px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
|  
+
| style="width: 455px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 427px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:40, 17 November 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;

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

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist

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