Difference between revisions of "API: Server configuration"

From BrainyCP
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 96: Line 96:
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 957px;"
+
{| style="width: 1051px;"
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера <font><font>API: web server status</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами <font><font>API: transfer between servers</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером <font><font>API: web server management</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера <font><font>API: web server installation</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер <font><font>API: FTP server</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
| style="width: 301px;" |  
+
| style="width: 303px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
| style="width: 302px;" |  
+
| style="width: 348px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
| style="width: 332px;" |  
+
| style="width: 378px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

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

properties

Server properties at the time of request execution (date and time, time zone, hostname, language, etc.).

getproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
getproperties (post or get) * - constant, operation type;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Information was received successfully';
error: 1, mess: 'An error occurred while receiving information';
error: 1000, mess: 'You do not have administrator rights'. If done correctly, the array will contain the following elements:
[time], [locale], [hostname], [tz_date], [tz_time], [tz_time_m], [tz_time_s], [tz_time_h], [tz_timezone], [timezone_path], [timezone_name], [tz_sync]

properties

Change time.

settimeproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
settimeproperties (post or get) * - constant, operation type;
date (post or get) * - new time in the format 'Dec 14 00:05:00 EST 2016';
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'New date was set successfully';
error: 1, mess: 'New time has been set';
error: 1000, mess: 'You do not have administrator rights'.

properties

Change time zone.

settzproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
settzproper (post or get) * - constant, operation type;
tz (post or get) * - new time zone. For example, EST or WET;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Time zone changed successfully';
error: 1, mess: 'An error occurred while changing the time zone';
error: 2, mess: 'The specified time zone is invalid';
error: 1000, mess: 'You do not have administrator rights'.

properties

Change Hostname.

sethostnameproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
sethostnameproper (post or get) * - constant, operation type;
hostname (post or get) * - new hostname;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'New hostname set';
error: 1, mess: 'An error occurred while setting a new hostname';
error: 2, mess: 'Invalid hostname';
error: 1000, mess: 'You do not have administrator rights'.

properties

Change root-password.

changerootpassprop

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
changerootpassprop (post or get) * - constant, operation name;
rootps (post or get) * - new password for root;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Root password changed successfully';
error: 1, mess: 'An error occurred while changing the root password';
error: 2, mess: 'The new root password is too short, at least 8 characters';
error: 1000, mess: 'You do not have administrator rights'

properties

Change brainysql-password.

changebrainysqlpassproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
changebrainysqlpassproper (post or get) * - constant, operation name;
rootps (post or get) * - new password for brainysql;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The password for brainysql has been successfully changed;
error: 1, mess: 'An error occurred while changing the password for brainysql';
error: 2, mess: 'The new password for brainysql is too short, at least 8 characters';
error: 1000, mess: 'You do not have administrator rights'.

properties

Change language.

changelangproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
changelangproper (post or get) * - constant, operation name;
lang (post or get) * - setting the language ('ru' or 'en');
language (post or get) - can take the value: en / ru (ru by default).
  
error: 0, mess: 'The selected language has been successfully installed';
error: 2, mess: 'Invalid language parameter specified';
error: 1000, mess: 'You do not have administrator rights'.

properties

Change data for sending mails by panel.

changetypemailproper

username (post or get) * - username;
password (post or get) * - user password;
properties (post or get) * - constant, module name;
changetypemailproper (post or get) * - constant, operation name:
type (post or get) * - mail sender (smtp or phpmail);
language (post or get) - can take the value: en / ru (ru by default). if 'type' = smtp, then the following parameters are requested:
smtp_user (post or get) * - mailbox on behalf of whom the authentication is going on;
smtp_pass (post or get) * - password for this user;
smtp_port (post or get) * - smtp port;
smtp_host (post or get) * - hostname of the smtp service;
encoding (post or get) - encoding;
smtp_from (post or get) - sender's name;
smtp_headers - headers. if 'type' = phpmail, then the following parameters are requested:
smtp_headers (post or get) - headers.
error: 0, mess: 'New parameters have been successfully applied';
error: 2, mess: 'The specified mailbox is invalid';
error: 3, mess: 'The specified hostname is invalid';
error: 4, mess: 'The port is not defined or it is invalid';
error: 1000, mess: 'You do not have administrator rights'.

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:_Server_configuration&oldid=1931"