Difference between revisions of "API: Server info"
From BrainyCP
m (Protected "API: Server info" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
| | ||
− | <div data-placeholder="Перевод" dir="ltr">Administrative functions require API root rights | + | <div data-placeholder="Перевод" dir="ltr"><font style="vertical-align: inherit;"><font style="vertical-align: inherit;">Administrative functions require API root rights to use any login hosted on the server. If you do not have root rights, you can only use your username.<br/> Incoming data marked with an asterisk is required.</font></font></div> |
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''<font style="vertical-align: inherit;"><font style="vertical-align: inherit;">Модуль</font></font>'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''<font style="vertical-align: inherit;"><font style="vertical-align: inherit;">Функция</font></font>'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''<font style="vertical-align: inherit;"><font style="vertical-align: inherit;">Входящие данные</font></font>'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''<font style="vertical-align: inherit;"><font style="vertical-align: inherit;">Варианты ошибок</font></font>'''</p> |
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | hardware_info | + | <font style="vertical-align: inherit;"><font style="vertical-align: inherit;">hardware_info</font></font> |
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | Getting all | + | <font style="vertical-align: inherit;"><font style="vertical-align: inherit;">Getting all information about the server.</font></font> |
− | hardware_info | + | <font style="vertical-align: inherit;"><font style="vertical-align: inherit;">hardware_info</font></font> |
− | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr"><font style="vertical-align: inherit;"><font style="vertical-align: inherit;">username (post or get) * - login;<br/> password (send or receive) * - user password;<br/> hardware_info (post or get) * - constant, module name;<br/> hardware_info (post or get) * - constant, operation name;<br/> language (send or receive) - can take the value: en / ru (ru by default).</font></font></div> |
− | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: ' | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr"><font style="vertical-align: inherit;"><font style="vertical-align: inherit;">error: 0, mess: 'Information about the system', detail [array_info];<br/> error: 400, mess: 'Unfortunately, the module is not available to you.'</font></font></div> |
|} | |} | ||
Other useful articles: | Other useful articles: | ||
− | {| style="width: | + | {| style="width: 1090px;" |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[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: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[https://docs.brainycp.io/index.php/API:_FTP- | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 304px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 341px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 423px;" | |
− | '''[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>]''' |
|} | |} | ||
| |
Latest revision as of 15:01, 17 November 2021
Administrative functions require API root rights to use any login hosted on the server. If you do not have root rights, you can only use your username.
Incoming data marked with an asterisk is required.
Incoming data marked with an asterisk is required.
Модуль |
Функция |
Входящие данные |
Варианты ошибок |
hardware_info |
Getting all information about the server. hardware_info |
username (post or get) * - login;
password (send or receive) * - user password; hardware_info (post or get) * - constant, module name; hardware_info (post or get) * - constant, operation name; language (send or receive) - can take the value: en / ru (ru by default). |
error: 0, mess: 'Information about the system', detail [array_info];
error: 400, mess: 'Unfortunately, the module is not available to you.' |
Other useful articles: