Difference between revisions of "API: App manager"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
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 data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div>
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.&nbsp;
 
−
 
 
 
{| 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>  
+
| <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <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;" |  
Line 15: Line 13:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Список приложений.
+
List of applications.
  
 
list_applications
 
list_applications
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
username (post или get)* — Username;
  
−
password (post или get)* — пароль пользователя;
+
password (post или get)* — User password;
  
−
packet_manager (post или get)* — константа, имя модуля;
+
packet_manager (post или get)* —constant, module name;
  
−
list_applications (post или get)* — константа, имя операции;
+
list_applications (post или get)* — constant, operation name;
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
language (post или get) — can take the value: en/ru (by default ru).
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Список приложений', detail [array_application];
+
error:0, mess:'List of applications', detail [array_application];
  
−
error:100, mess:'Список приложений пуст';
+
error:100, mess:'List of applications is empty';
  
−
error:400, mess:'К сожалению, модуль вам не доступен'.
+
error:400, mess:'Unfortunately, this module is not available for you'.
  
 
|-
 
|-
Line 42: Line 40:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Установка приложения.
+
Installing application.
  
 
install_application
 
install_application
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
username (post или get)* — Username;
  
−
password (post или get)* — пароль пользователя;
+
password (post или get)* — User password;
  
−
packet_manager (post или get)* — константа, имя модуля;
+
packet_manager (post или get)* — Constant, module name;
  
−
install_application (post или get)* — константа, имя операции;
+
install_application (post или get)* — constant, operation name;
  
−
service (post или get)* — выбор сервиса;
+
service (post или get)* — selecting a service;
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
language (post или get) — can take a value: en/ru (by default ru).
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Команда выполнена', detail [id_stream];
+
error:0, mess:'Command is performed', detail [id_stream];
  
−
error:100, mess:'Неправильно указан сервис', detail [array_service];
+
error:100, mess:'The servise is set incorrectly', detail [array_service];
  
−
error:400, mess:'К сожалению, модуль вам не доступен'.
+
error:400, mess:'Unfortunately, this module is not available for you'.
  
 
|-
 
|-
Line 71: Line 69:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удаление приложения.
+
Deleting application.
  
 
delete_application
 
delete_application
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
username (post или get)* — Username;
  
−
password (post или get)* — пароль пользователя;
+
password (post или get)* — User password;
  
−
packet_manager (post или get)* — константа, имя модуля;
+
packet_manager (post или get)* — кconstant, module name;
  
−
delete_application (post или get)* — константа, имя операции;
+
delete_application (post или get)* — constant, operation name;
  
−
service (post или get)* — выбор сервиса;
+
service (post или get)* — selecting a service;
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
language (post или get) — can take a value: en/ru (by default ru).
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Команда выполнена', detail [id_stream];
+
error:0, mess:'Command is performed', detail [id_stream];
  
−
error:100, mess:'Неправильно указан сервис', detail [array_service];
+
error:100, mess:'The serviced is incorrectly set', detail [array_service];
  
−
error:400, mess:'К сожалению, модуль вам не доступен'.
+
error:400, mess:'Unfortunately, this module is unavailable for you'.
  
 
|-
 
|-
Line 100: Line 98:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Старт/стоп/рестарт/добавление в автозагрузку/удаление из автозагрузки приложения.
+
Start / Stop / Restart / Adding to auto installer/ deleting from auto installer.
  
 
operation
 
operation
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
username (post или get)* — Username;
  
−
password (post или get)* — пароль пользователя;
+
password (post или get)* — user password;
  
−
packet_manager (post или get)* — константа, имя модуля;
+
packet_manager (post или get)* — constant, module name;
  
−
operation (post или get)* — константа, имя операции;
+
operation (post или get)* — constant, operation name;
  
−
service (post или get)* — выбор сервиса;
+
service (post или get)* — selecting a service;
  
−
command (post или get)* — выбор команды:
+
command (post или get)* — select a command:
  
−
autoload_true — добавить в автозагрузку;
+
autoload_true — add to auto installer;
  
−
autoload_false — убрать из автозагрузки;
+
autoload_false — remove from auto installer;
  
−
start — запустить сервис;
+
start — start service;
  
−
stop — остановить сервис;
+
stop — stop service;
  
−
restart — перезапуск сервиса.
+
restart — restart service.
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
language (post или get) — can take a value: en/ru (by default ru).
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Команда выполнена', detail [console message];
+
error:0, mess:'Command is performed', detail [console message];
 +
 
 +
error:100, mess:'The command is entered incorrectly', detail [list of commands];
 +
 
 +
error:101, mess:'Error in performing the command';
 +
 
 +
error:400, mess:'Unfortunately, this module is unavailable for you'.
 +
 
 +
|}
 +
 
 +
Other useful articles:
 +
 
 +
{| style="width: 1030px;"
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
error:100, mess:'Неправильно введена команда', detail [список команд];
+
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
 +
 
 +
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
 +
 
 +
|-
 +
| style="width: 276px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
error:101, mess:'Ошибка в выполнении команды';
+
| style="width: 369px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:400, mess:'К сожалению. модуль вам не доступен'.
+
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

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

packet_manager

List of applications.

list_applications

username (post или get)* — Username;

password (post или get)* — User password;

packet_manager (post или get)* —constant, module name;

list_applications (post или get)* — constant, operation name;

language (post или get) — can take the value: en/ru (by default ru).

error:0, mess:'List of applications', detail [array_application];

error:100, mess:'List of applications is empty';

error:400, mess:'Unfortunately, this module is not available for you'.

packet_manager

Installing application.

install_application

username (post или get)* — Username;

password (post или get)* — User password;

packet_manager (post или get)* — Constant, module name;

install_application (post или get)* — constant, operation name;

service (post или get)* — selecting a service;

language (post или get) — can take a value: en/ru (by default ru).

error:0, mess:'Command is performed', detail [id_stream];

error:100, mess:'The servise is set incorrectly', detail [array_service];

error:400, mess:'Unfortunately, this module is not available for you'.

packet_manager

Deleting application.

delete_application

username (post или get)* — Username;

password (post или get)* — User password;

packet_manager (post или get)* — кconstant, module name;

delete_application (post или get)* — constant, operation name;

service (post или get)* — selecting a service;

language (post или get) — can take a value: en/ru (by default ru).

error:0, mess:'Command is performed', detail [id_stream];

error:100, mess:'The serviced is incorrectly set', detail [array_service];

error:400, mess:'Unfortunately, this module is unavailable for you'.

packet_manager

Start / Stop / Restart / Adding to auto installer/ deleting from auto installer.

operation

username (post или get)* — Username;

password (post или get)* — user password;

packet_manager (post или get)* — constant, module name;

operation (post или get)* — constant, operation name;

service (post или get)* — selecting a service;

command (post или get)* — select a command:

autoload_true — add to auto installer;

autoload_false — remove from auto installer;

start — start service;

stop — stop service;

restart — restart service.

language (post или get) — can take a value: en/ru (by default ru).

error:0, mess:'Command is performed', detail [console message];

error:100, mess:'The command is entered incorrectly', detail [list of commands];

error:101, mess:'Error in performing the command';

error:400, mess:'Unfortunately, this module is unavailable for you'.

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:_App_manager&oldid=1926"