Difference between revisions of "API: Network tools"
From BrainyCP
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <div data-placeholder="Перевод" dir="ltr">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.</div> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div> | |
− | |||
− | |||
− | |||
− | |||
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Module'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Function'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Error variants'''</p> |
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
network_tools | network_tools | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Lists an array of iptables rules.</div> |
− | |||
− | |||
list_iptables | list_iptables | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;<br/> </div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;<br/> </div> <div data-placeholder="Перевод" dir="ltr">network_tools (post or get) * - constant, module name;<br/> </div> <div data-placeholder="Перевод" dir="ltr">list_iptables (post or get) * - constant, operation name;<br/> </div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'List of rules';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mes: 'The list of rules is not available';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | network_tools (post | ||
− | |||
− | list_iptables (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mes: ' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 42: | Line 20: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Add rule<br/> iptables. | |
add_rules | add_rules | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;<br/> </div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;<br/> </div> <div data-placeholder="Перевод" dir="ltr">network_tools (post or get) * - constant, module name;<br/> </div> <div data-placeholder="Перевод" dir="ltr">add_rules (post or get) * - constant, operation name;<br/> </div> <div data-placeholder="Перевод" dir="ltr">rules (post) * - add a rule (for example: -A INPUT -s 11.11.11.22 -j DROP);<br/> </div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'The rule was saved successfully';<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess 'Error saving the rule', delail [console_message];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | network_tools (post | ||
− | |||
− | add_rules (post | ||
− | |||
− | rules (post)* | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, message:' | ||
− | |||
− | error:100, mess ' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 71: | Line 31: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Delete rule by number | |
delete_rules | delete_rules | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">network_tools (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_rules (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">name_rules (post or get) * - the name of the rule ("" INPUT "" "" "" FORWARD "" "" "OUTPUT" "" "" "ALLOWIN" "" "" ALLOWOUT "" "" "" DENYIN "" "" "DENYOUT "",</div> <div data-placeholder="Перевод" dir="ltr">"" INVALID "" "" "" INVDROP "" "" "" LOCALINPUT "" "" "LOCALOUTPUT" "" "" LOGDROPIN "" "" "LOGDROPOUT" ");</div> <div data-placeholder="Перевод" dir="ltr">id_rules (post or get) * - rule number;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Rule deleted successfully';<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'To delete, you need 2 values (name_rules, id_rules)';<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The variable name_rules was entered incorrectly', detail [list_name_rules];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess 'Error deleting rule', delail [console_message];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | network_tools (post | ||
− | |||
− | delete_rules (post | ||
− | |||
− | name_rules (post | ||
− | |||
− | ""INVALID"" | ||
− | |||
− | id_rules (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:1, mess:' | ||
− | |||
− | error:2, mess:' | ||
− | |||
− | error:100, mess ' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
network_tools | network_tools | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Start / stop / restart / save iptables.</div> |
− | |||
− | |||
comand_iptables | comand_iptables | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">backup (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">select_comand (post or get) * - command:</div> <div data-placeholder="Перевод" dir="ltr">start - start iptables;</div> <div data-placeholder="Перевод" dir="ltr">stop - stop iptables;</div> <div data-placeholder="Перевод" dir="ltr">restart - restart iptables;</div> <div data-placeholder="Перевод" dir="ltr">save - save iptables.</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Command completed', delail [console_message];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Incorrect command specified.' delail [list_comand];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | backup (post | ||
− | |||
− | select_comand(post | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:2, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 143: | Line 51: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Display all amount of connections<br/> all_conection | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">network_tools (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">all_conection (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> | ||
+ | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Total number of connections', delail [console_message];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> | ||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 166: | Line 60: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Displays connections in SYN_RECEIVED state. | |
all_conection_syn_received | all_conection_syn_received | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">network_tools (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">all_conection_syn_received (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Total number of SYN_RECEIVED connections', delail [console_message];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | network_tools (post | ||
− | |||
− | all_conection_syn_received (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
network_tools | network_tools | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Displays all connections to the selected port.</div> |
− | |||
− | |||
all_conection_port | all_conection_port | ||
− | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">network_tools (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">all_conection_port (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Total connections to the selected port', delail [console_message];<br/> </div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | network_tools (post | ||
− | |||
− | all_conection_port (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1113px;" |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 313px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 372px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 406px;" | |
− | '''[https://docs.brainycp. | + | '''[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 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 |
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: