Difference between revisions of "API: Antivirus"

From BrainyCP
Jump to: navigation, search
m (Protected "API: Antivirus" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Line 67: Line 67:
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 1197px;"
+
{| style="width: 1023px;"
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[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: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
| style="width: 359px;" |  
+
| style="width: 276px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]'''
  
−
| style="width: 346px;" |  
+
| style="width: 354px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]'''
  
−
| style="width: 472px;" |  
+
| style="width: 371px;" |  
−
'''[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>]'''
  
 
|}
 
|}

Revision as of 11: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

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=1867"