Difference between revisions of "API: Network tools"

From BrainyCP
Jump to: navigation, search
 
Line 79: Line 79:
 
Other useful articles:
 
Other useful articles:
  
{| style="width: 998px;"
+
{| style="width: 1113px;"
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера <font><font>API: web server status</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами <font><font>API: transfer between servers</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером <font><font>API: web server management</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера <font><font>API: web server installation</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер <font><font>API: FTP server</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
| style="width: 304px;" |  
+
| style="width: 313px;" |  
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
| style="width: 278px;" |  
+
| style="width: 372px;" |  
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 406px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:32, 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

network_tools

Lists an array of iptables rules.

list_iptables

username (post or get) * - username;
 
password (post or get) * - user password;
 
network_tools (post or get) * - constant, module name;
 
list_iptables (post or get) * - constant, operation name;
 
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'List of rules';
error: 100, mes: 'The list of rules is not available';
error: 400, mess: 'Unfortunately, the module is not available to you.'

network_tools

Add rule
iptables.

add_rules

username (post or get) * - username;
 
password (post or get) * - user password;
 
network_tools (post or get) * - constant, module name;
 
add_rules (post or get) * - constant, operation name;
 
rules (post) * - add a rule (for example: -A INPUT -s 11.11.11.22 -j DROP);
 
language (post or get) - can take the value: en / ru (ru by default).
error: 0, message: 'The rule was saved successfully';
 
error: 100, mess 'Error saving the rule', delail [console_message];
 
error: 400, mess: 'Unfortunately, the module is not available to you.'

network_tools

Delete rule by number   

delete_rules

username (post or get) * - username;
password (post or get) * - user password;
network_tools (post or get) * - constant, module name;
delete_rules (post or get) * - constant, operation name;
name_rules (post or get) * - the name of the rule ("" INPUT "" "" "" FORWARD "" "" "OUTPUT" "" "" "ALLOWIN" "" "" ALLOWOUT "" "" "" DENYIN "" "" "DENYOUT "",
"" INVALID "" "" "" INVDROP "" "" "" LOCALINPUT "" "" "LOCALOUTPUT" "" "" LOGDROPIN "" "" "LOGDROPOUT" ");
id_rules (post or get) * - rule number;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Rule deleted successfully';
 
error: 1, mess: 'To delete, you need 2 values ​​(name_rules, id_rules)';
 
error: 2, mess: 'The variable name_rules was entered incorrectly', detail [list_name_rules];
 
error: 100, mess 'Error deleting rule', delail [console_message];
 
error: 400, mess: 'Unfortunately, the module is not available to you.'

network_tools

Start / stop / restart / save iptables.

comand_iptables

username (post or get) * - username;
password (post or get) * - user password;
backup (post or get) * - constant, module name;
select_comand (post or get) * - command:
start - start iptables;
stop - stop iptables;
restart - restart iptables;
save - save iptables.
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Command completed', delail [console_message];
 
error: 2, mess: 'Incorrect command specified.' delail [list_comand];
 
error: 400, mess: 'Unfortunately, the module is not available to you.'

network_tools

Display all amount of connections
all_conection

username (post or get) * - username;
password (post or get) * - user password;
network_tools (post or get) * - constant, module name;
all_conection (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Total number of connections', delail [console_message];
 
error: 400, mess: 'Unfortunately, the module is not available to you.'

network_tools

Displays connections in SYN_RECEIVED state.

all_conection_syn_received

username (post or get) * - username;
password (post or get) * - user password;
network_tools (post or get) * - constant, module name;
all_conection_syn_received (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Total number of SYN_RECEIVED connections', delail [console_message];
 
error: 400, mess: 'Unfortunately, the module is not available to you.'

network_tools

Displays all connections to the selected port.

all_conection_port

username (post or get) * - username;
password (post or get) * - user password;
network_tools (post or get) * - constant, module name;
all_conection_port (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Total connections to the selected port', delail [console_message];
 
error: 400, mess: 'Unfortunately, the module is not available to you.'

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