API: Network tools
From BrainyCP
Revision as of 13:00, 26 July 2021 by Alenka (talk | contribs) (Protected "API: Network tools" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
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:
