Difference between revisions of "API: Server configuration"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
 
+
<div data-placeholder="Перевод" dir="ltr">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> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div>
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
−
 
 
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.
 
−
 
 
 
{| 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;" |  
 
properties
 
properties
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Server properties at the time of request execution (date and time, time zone, hostname, language, etc.).</div>
−
Свойства сервера в момент выполнения запроса (дата и время, часовой пояс, hostname, язык и пр.).
 
−
 
 
 
getproper
 
getproper
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">getproperties (post or get) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Information was received successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while receiving information';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'. If done correctly, the array will contain the following elements:</div> <div data-placeholder="Перевод" dir="ltr">[time], [locale], [hostname], [tz_date], [tz_time], [tz_time_m], [tz_time_s], [tz_time_h], [tz_timezone], [timezone_path], [timezone_name], [tz_sync]</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
properties (post или get)* — константа, имя модуля;
 
−
 
 
−
getproperties (post или get)* &nbsp;— константа, тип операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Информация была успешно получена';
 
−
 
 
−
error:1, mess:'Произошла ошибка при получении информации';
 
−
 
 
−
error:1000, mess:'У вас нет прав администратора'. &nbsp; Если все сделано правильно, массив <data>будет содержать следующие элементы:</data>
 
−
 
 
−
[time], [locale],[hostname],[tz_date],[tz_time],[tz_time_m],[tz_time_s],[tz_time_h],[tz_timezone],[timezone_path],[timezone_name], [tz_sync]
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 44: Line 20:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Смена времени.
+
Change time.
  
 
settimeproper
 
settimeproper
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">settimeproperties (post or get) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">date (post or get) * - new time in the format 'Dec 14 00:05:00 EST 2016';</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New date was set successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'New time has been set';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
properties (post или get)* — константа, имя модуля;
 
−
 
 
−
settimeproperties (post или get)* — константа, тип операции;
 
−
 
 
−
date (post или get)* — новое время в формате 'Dec 14 00:05:00 EST 2016';
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Новая дата была успешно установлена';
 
−
 
 
−
error:1, mess:'Новое время было установлено';
 
−
 
 
−
error:1000, mess:'У вас нет прав администратора'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 73: Line 31:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Смена часового пояса.
+
Change time zone.
  
 
settzproper
 
settzproper
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">settzproper (post or get) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">tz (post or get) * - new time zone. For example, EST or WET;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Time zone changed successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while changing the time zone';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified time zone is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
properties (post или get)* — константа, имя модуля;
 
−
 
 
−
settzproper (post или get)* — константа, тип операции;
 
−
 
 
−
tz (post или get)* — новый часовой пояс. Например, EST или WET;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Часовой пояс успешно изменен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при смене часового пояса';
 
−
 
 
−
error:2, mess:'Указанный часовой пояс некорректный';
 
−
 
 
−
error:1000, mess:'У вас нет прав администратора'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 104: Line 42:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Смена Hostname.
+
Change Hostname.
  
 
sethostnameproper
 
sethostnameproper
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">sethostnameproper (post or get) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">hostname (post or get) * - new hostname;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New hostname set';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while setting a new hostname';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Invalid hostname';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
properties (post или get)* — константа, имя модуля;
 
−
 
 
−
sethostnameproper (post или get)* — константа, тип операции;
 
−
 
 
−
hostname (post или get)* — новое имя хоста;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Новое имя хоста установлено';
 
−
 
 
−
error:1, mess:'Произошла ошибка при установке нового имени хоста';
 
−
 
 
−
error:2, mess:'Никорректное имя хоста';
 
−
 
 
−
error:1000, mess:'У вас нет прав администратора'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 135: Line 53:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Смена root-пароля.
+
Change root-password.
  
 
changerootpassprop
 
changerootpassprop
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">changerootpassprop (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">rootps (post or get) * - new password for root;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Root password changed successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while changing the root password';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The new root password is too short, at least 8 characters';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
properties
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
properties (post или get)* — константа, имя модуля;
 
−
 
 
−
changerootpassprop (post или get)* — константа, имя операции;
 
−
 
 
−
rootps (post или get)* — новый пароль для root;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).<br/> &nbsp;
 
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Пароль пользователя root успешно изменен';
+
Change brainysql-password.
  
−
error:1, mess:'Произошла ошибка при изменении пароля пользователя root';
+
changebrainysqlpassproper
−
 
 
−
error:2, mess:'Новый пароль для root слишком короткий, не менее 8 символов';
 
−
 
 
−
error:1000, mess:'У вас нет прав администратора'
 
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">changebrainysqlpassproper (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">rootps (post or get) * - new password for brainysql;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The password for brainysql has been successfully changed;</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while changing the password for brainysql';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The new password for brainysql is too short, at least 8 characters';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'.</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 166: Line 75:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Смена brainysql-пароля.
+
Change language.
  
−
changebrainysqlpassproper
+
changelangproper
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">changelangproper (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">lang (post or get) * - setting the language ('ru' or 'en');</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
 +
| style="vertical-align: top;" | &nbsp; <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The selected language has been successfully installed';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Invalid language parameter specified';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'.</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
properties
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
properties (post или get)* — константа, имя модуля;
 
−
 
 
−
changebrainysqlpassproper (post или get)* — константа, имя операции;
 
−
 
 
−
rootps (post или get)* — новый пароль для brainysql;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Пароль для brainysql успешно изменен;
+
Change data for sending mails by panel.
  
−
error:1, mess:'Произошла ошибка при изменении пароля для brainysql';
+
changetypemailproper
  
−
error:2, mess:'Новый пароль для brainysql слишком короткий, не менее 8 символов';
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">properties (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">changetypemailproper (post or get) * - constant, operation name:</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - mail sender (smtp or phpmail);</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default). if 'type' = smtp, then the following parameters are requested:</div> <div data-placeholder="Перевод" dir="ltr">smtp_user (post or get) * - mailbox on behalf of whom the authentication is going on;</div> <div data-placeholder="Перевод" dir="ltr">smtp_pass (post or get) * - password for this user;</div> <div data-placeholder="Перевод" dir="ltr">smtp_port (post or get) * - smtp port;</div> <div data-placeholder="Перевод" dir="ltr">smtp_host (post or get) * - hostname of the smtp service;</div> <div data-placeholder="Перевод" dir="ltr">encoding (post or get) - encoding;</div> <div data-placeholder="Перевод" dir="ltr">smtp_from (post or get) - sender's name;</div> <div data-placeholder="Перевод" dir="ltr">smtp_headers - headers. if 'type' = phpmail, then the following parameters are requested:</div> <div data-placeholder="Перевод" dir="ltr">smtp_headers (post or get) - headers.</div>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New parameters have been successfully applied';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified mailbox is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'The specified hostname is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 4, mess: 'The port is not defined or it is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights'.</div>
 +
|}
  
−
error:1000, mess:'У вас нет прав администратора'.
+
Other useful articles:
  
 +
{| style="width: 1051px;"
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 303px;" |  
−
properties
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 348px;" |  
−
Смена языка.
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
changelangproper
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
username (post или get)* — имя пользователя;
+
| style="width: 303px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
properties (post или get)* — константа, имя модуля;
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
−
changelangproper (post или get)* — константа, имя операции;
+
|-
 +
| style="width: 303px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
lang (post или get)* — установка язык ('ru' или 'en');
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
−
| style="vertical-align: top;" | &nbsp;
+
|-
−
error:0, mess:'Выбранный язык успешно установлен';
+
| style="width: 303px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
error:2, mess:'Указан некорректный параметр выбора языка';
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
error:1000, mess:'У вас нет прав администратора'.<br/> &nbsp;
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 303px;" |  
−
properties
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 348px;" |  
−
Смена данных для отправки почты панелью.
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
changetypemailproper
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
username (post или get)* — имя пользователя;
+
| style="width: 303px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
password (post или get)* — пароль пользователя;
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
properties (post или get)* — константа, имя модуля;
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
−
changetypemailproper (post или get)* — константа, имя операции:
+
|-
 +
| style="width: 303px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
type (post или get)* — отправитель почты (smtp или phpmail);
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru). &nbsp; если 'type' = smtp, то запрашиваются следующие параметры:
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;smtp_user (post или get)* — почтовый ящик от имени кого идет аутентификация;
+
|-
 +
| style="width: 303px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;smtp_pass (post или get)* — пароль к этому пользователю;
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;smtp_port (post или get)* — smtp-порт;
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;smtp_host (post или get)* — имя узла сервиса smtp;
+
|-
 +
| style="width: 303px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;encoding(post или get) — кодировка;
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;smtp_from (post или get) — имя отправителя;
+
| style="width: 378px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
−
&nbsp;&nbsp;&nbsp;&nbsp;smtp_headers — заголовки. &nbsp; &nbsp;&nbsp;если 'type' = phpmail, то запрашиваются следующие параметры:
+
|-
−
 
+
| style="width: 303px;" |  
−
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;smtp_headers (post или get) — заголовки.
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
−
 
 
−
| style="vertical-align: top;" | &nbsp;
 
−
error:0, mess:'Новые параметры успешно применены';
 
−
 
 
−
error:2, mess:'Указанный почтовый ящик некорректный';
 
−
 
 
−
error:3, mess:'Указанное имя хоста некорректно';
 
  
−
error:4, mess:'Не определен порт или он некорректный';
+
| style="width: 348px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:1000, mess:'У вас нет прав администратора'.
+
| style="width: 378px;" |
 +
'''[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"