Difference between revisions of "API: Manage webserver"
From BrainyCP
m (Protected "API: Manage webserver" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|||
| Line 120: | Line 120: | ||
Other useful articles: | Other useful articles: | ||
| − | {| style="width: | + | {| style="width: 1018px;" |
|- | |- | ||
| − | | | + | | style="width: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_подключение API: | + | '''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_мониторинг API: | + | '''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: | + | '''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: | + | '''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_антивирус API: | + | '''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: | + | '''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_базы_данных API: | + | '''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: | + | '''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: | + | '''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
| − | | | + | | style="width: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: | + | '''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_почта API: | + | '''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: | + | '''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
| − | | | + | | style="width: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_использование_трафика API: | + | '''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: | + | '''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_логирование API: | + | '''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_сервер_имен API: | + | '''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: | + | '''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
| − | | | + | | style="width: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: | + | '''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: | + | '''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: | + | '''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: | + | '''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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: 291px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: | + | '''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]''' |
| − | | | + | | style="width: 335px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: | + | '''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]''' |
| − | | | + | | style="width: 370px;" | |
| − | '''[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 12:24, 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 |
|
apacserver |
Setting a password for a directory.
set_password |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; set_password (post or get) * - constant, operation name; directory (post or get) * - directory; password (post) * - password; 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: 'Success'; error: -1, mess: 'The directory does not exist or the format is invalid'; error: -1, mess: 'Weak password'; error: -2, mess: 'The password for this folder already exists'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Removing a directory
. delete_password |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; delete_password (post or get) * - constant, operation name; directory (post or get) * - directory; 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: 'Success'; error: -1, mess: 'Not completed'; error: 100, mess: 'The directory does not exist or the format is invalid'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Browse password-protected directories.
list_directory |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; list_directory (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: 'List of password-protected directories', detail [array_directory]; error: 100, mess: 'The list of password-protected directories is empty'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Redirect from http to https / https to http.
add_http |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; add_http (post or get) * - constant, operation name; site (post or get) * - domain for redirection; type (post or get) * - type of redirection (http, https); 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: 'Forwarding added successfully'; error: -1, mess: 'This type of forwarding already exists; error: -1, mess: 'A redirect already exists for this site .; error: 100, mess: 'This is not yours', detail [list_domain; error: 101, mess: 'Non-existent type', detail [array_type]; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Show list of sites.
list_http |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; list_http (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: 'List of domains', detail [array_domain]; error: 100, mess: 'The list of domains is empty'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Listing directories.
list_directory_http |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; list_directory_http (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: 'List of Directories', detail [array_directory]; error: 100, mess: 'Directory List is empty'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Delete directory. delete_http |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; delete_http (post or get) * - constant, operation name; site (post or get) * - domain (redirect to be deleted); uniq_id (post or get) * - unique identifier; 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: 'Forwarding successfully deleted'; error: -1, mess: 'There are no rights for this operation!'; error: 100, mess: 'This is not yours'; error: 400, message: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Display a list of redirects.
list_www |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; list_www (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, message: 'Forwarding list', detail [array_forwarding]; error: 100, message: 'The forwarding list is empty'; error: 400, message: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Delete redirect delete_www |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; delete_www (post or get) * - constant, operation name; uniq_id (post or get) * - uical identifier (needed for deletion); 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: 'Forwarding successfully deleted'; error: -1, mess: 'There are no rights for this operation!'; error: 100, mess: 'The unic_id was entered incorrectly. Or this redirection is no longer there '; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
|
apacserver |
Web-redirect add_www |
username (post or get) * - username; password (post or get) * - user password; apacserver (post or get) * - constant, module name; add_www (post or get) * - constant, operation name; domain (post) * - domain; select_www (post or get) * - redirect method; site_forwarding (post) * - where the redirect leads; src (post or get) * - path for forwarding; draft (post or get) - false by default; 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: 'Forwarding added successfully'; error: -1, mess: 'This type of forwarding already exists'; error: -1, mess: 'Invalid destination format'; error: -1, mess: 'Invalid site name format'; error: -1, mess: 'There are no rights for this operation!'; error: 101, mess: 'Domain does not exist.', detail [array_list_domain]; error: 102, mess: 'Forwarding assigned incorrectly', detail [array_list_forwarding]; error: 103, mess: 'No forwarding path specified'.
|
Other useful articles:
