Difference between revisions of "API: Antivirus"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(9 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>
 +
&nbsp;
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
−
 
−
Входящие данные, отмеченные звездочкой обязательны для заполнения.
 
−
/> /> /> />
 
 
{| 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>  
+
| style="width: 137px;" | <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| style="width: 365px;" | <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;" |  
 
antivirus
 
antivirus
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 137px;" |  
−
Проверка каталога.
+
Checking catalog.
  
 
scan_folder
 
scan_folder
  
 +
| style="vertical-align: top; width: 365px;" | <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">antivirus (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">scan_folder (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">auto_carantine (post or get) - default = 0;</div> <div data-placeholder="Перевод" dir="ltr">auto_delete (post or get) * - default = 0;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Scanning completed successfully', detail;</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Scanning completed with an error', detail;</div> <div data-placeholder="Перевод" dir="ltr">error: 10, mess: 'Scan time exceeded';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The directory does not exist';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
antivirus
  
−
password (post или get)* — пароль пользователя;
+
| style="vertical-align: top; width: 137px;" |
 +
Viewing scan results.
  
−
antivirus (post или get)* — константа, имя модуля;
+
show_history
−
 
 
−
scan_folder (post или get)* — константа, имя операции;
 
−
 
 
−
auto_carantine (post или get) — по умолчанию =0;
 
−
 
 
−
auto_delete (post или get)* — по умолчанию =0;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
  
 +
| style="vertical-align: top; width: 365px;" | <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">antivirus (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_history (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">id_history (post or get) - id of the viewed history;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Scan history received';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The file being viewed is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'There is no such history id';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Сканирование успешно выполнено',detail;
+
antivirus
  
−
error:1, mess:'Сканирование выполнено с ошибкой',detail;
+
| style="vertical-align: top; width: 137px;" |
 +
Displaying scan history for users.
  
−
error:10, mess:'Превышено время сканирования';
+
scan_history
−
 
 
−
error:100, mess:'Директории не существует';
 
−
 
 
−
error:400, mess:'У вас не достаточно прав. Уберите user_edit'.
 
  
 +
| style="vertical-align: top; width: 365px;" | <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">antivirus (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">scan_history (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Scan history received';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The array of scan history is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
antivirus
 
antivirus
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 137px;" |  
−
Просмотр результатов сканирования.
+
Updating antivirus database.
  
−
show_history
+
update_antivirus
  
 +
| style="vertical-align: top; width: 365px;" | <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">antivirus (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">update_antivirus (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: 'Request completed', detail;</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'The update was completed with an error', detail;</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The directory does not exist';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit ';</div> <div data-placeholder="Перевод" dir="ltr">error: 401, mess: 'You do not have sufficient rights'.</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
antivirus
  
−
password (post или get)* — пароль пользователя;
+
| style="vertical-align: top; width: 137px;" |
 +
Clear antivirus history.
  
−
antivirus (post или get)* — константа, имя модуля;
+
clear_history
  
−
show_history (post или get)* — константа, имя операции;
+
| style="vertical-align: top; width: 365px;" | <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">antivirus (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">clear_history (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: 'Update was successful';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
 +
|}
  
−
id_history (post или get) — id просматриваемой истории;
+
Other useful articles:
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
{| style="width: 1030px;"
 +
|-
 +
| style="width: 293px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 372px;" |  
−
error:0, mess:'История сканирования получена';
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
−
error:100, mess:'Просматриваемый файл пустой';
+
|-
 +
| style="width: 293px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
error:101, mess:'Такой id истории нет';
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 293px;" |  
−
antivirus
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 343px;" |  
−
Вывод истории сканирования для пользователя.
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
scan_history
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
username (post или get)* — имя пользователя;
+
| style="width: 293px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
antivirus (post или get)* — константа, имя модуля;
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
−
scan_history (post или get)* — константа, имя операции;
+
|-
 +
| style="width: 293px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
error:0, mess:'История сканирования получена';
+
| style="width: 293px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
error:100, mess:'Массив истории сканирования пустой';
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 293px;" |  
−
antivirus
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 343px;" |  
−
Обновление антивирусной базы.
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
update_antivirus
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
username (post или get)* — имя пользователя;
+
| style="width: 293px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
antivirus (post или get)* — константа, имя модуля;
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
update_antivirus (post или get)* — константа, имя операции;
+
|-
 +
| style="width: 293px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
| style="width: 343px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 372px;" |  
−
error:0, mess:'Запрос выполнен', detail;
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
−
 
 
−
error:1, mess:'Обновление выполнено с ошибкой', detail;
 
−
 
 
−
error:100, mess:'Директории не существует';
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit';
 
−
 
 
−
error:401, mess:'У вас недостаточно прав'.
 
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 293px;" |  
−
antivirus
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
−
 
 
−
| style="vertical-align: top;" |
 
−
Очистка истории сканирования.
 
−
 
 
−
clear_history
 
−
 
 
−
| style="vertical-align: top;" |
 
−
username (post или get)* — имя пользователя;
 
−
 
 
−
password (post или get)* — пароль пользователя;
 
  
−
antivirus (post или get)* — константа, имя модуля;
+
| style="width: 343px;" |  
−
 
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
−
clear_history (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Обновление успешно выполнено';
 
  
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
+
| style="width: 372px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

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

antivirus

Checking catalog.

scan_folder

username (post or get) * - username;
password (post or get) * - user password;
antivirus (post or get) * - constant, module name;
scan_folder (post or get) * - constant, operation name;
auto_carantine (post or get) - default = 0;
auto_delete (post or get) * - default = 0;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Scanning completed successfully', detail;
error: 1, mess: 'Scanning completed with an error', detail;
error: 10, mess: 'Scan time exceeded';
error: 100, mess: 'The directory does not exist';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

antivirus

Viewing scan results.

show_history

username (post or get) * - username;
password (post or get) * - user password;
antivirus (post or get) * - constant, module name;
show_history (post or get) * - constant, operation name;
id_history (post or get) - id of the viewed history;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Scan history received';
error: 100, mess: 'The file being viewed is empty';
error: 101, mess: 'There is no such history id';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

antivirus

Displaying scan history for users.

scan_history

username (post or get) * - username;
password (post or get) * - user password;
antivirus (post or get) * - constant, module name;
scan_history (post or get) * - constant, operation name;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Scan history received';
error: 100, mess: 'The array of scan history is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

antivirus

Updating antivirus database.

update_antivirus

username (post or get) * - username;
password (post or get) * - user password;
antivirus (post or get) * - constant, module name;
update_antivirus (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Request completed', detail;
error: 1, mess: 'The update was completed with an error', detail;
error: 100, mess: 'The directory does not exist';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit ';
error: 401, mess: 'You do not have sufficient rights'.

antivirus

Clear antivirus history.

clear_history

username (post or get) * - username;
password (post or get) * - user password;
antivirus (post or get) * - constant, module name;
clear_history (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Update was successful';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

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:_Antivirus&oldid=1920"