Difference between revisions of "API: Transfer between servers"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
 
 
+
<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>
Входящие данные, отмеченные звездочкой, обязательны для заполнения.&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;" |  
Вывод списка хост-аккаунтов на удаленном сервере.
+
Display the list of host-accounts on the remote server.
  
 
list_user
 
list_user
  
| 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_user (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection:</div> <div data-placeholder="Перевод" dir="ltr">password - connection when entering a password and login;</div> <div data-placeholder="Перевод" dir="ltr">key - connection with a private and public key.</div> <div data-placeholder="Перевод" dir="ltr">If password is selected:</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</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: 'Getting the list of users from the remote host', detail [array_remote_host];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ip';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'No remote login or password specified';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
transfer (post или get)* — константа, имя модуля;
 
 
 
list_user (post или get)* — константа, имя операции;
 
 
 
type (post или get)* — принимает тип соединения:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;password — соединение при вводе пароля и логина;
 
 
 
key — соединение с приватным и публичным ключом.
 
 
 
При выборе password:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;passremote (post или get)* — пароль на удаленном сервере.
 
 
 
При выборе key:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key (post или get)* — приватный ключ через encodeURIComponent; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере.
 
 
 
ip (post или get)* ip-адрес удаленного сервера;
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
| style="vertical-align: top;" |  
 
error:0, mess:'Получение списка пользователей с удаленного хоста', detail[array_remote_host];
 
 
 
error:100, mess:'Несоответствие типа';
 
 
 
error:101, mess:'Некорректный ip';
 
 
 
error:102, mess:'Не указан удаленный логин или пароль';
 
 
 
error:103, mess:'Не заполнены ip ключ или логин';
 
 
 
error:666, mess:'Вы пытаетесь проникнуть на запрещенную территорию';
 
 
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 66: Line 24:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Получение списка ip-адресов на удаленном сервере.
+
getting the list of ip-addresses on the remote server.
  
 
list_ip
 
list_ip
  
| 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_ip (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection:</div> <div data-placeholder="Перевод" dir="ltr">password - connection when entering a password and login;</div> <div data-placeholder="Перевод" dir="ltr">key - connection with a private and public key.</div> <div data-placeholder="Перевод" dir="ltr">If password is selected:</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server;</div> <div data-placeholder="Перевод" dir="ltr">passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</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: 'Getting ip list from remote host', detail [array_remote_ip];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ip';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'No remote login or password specified';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
transfer (post или get)* — константа, имя модуля;
 
 
 
list_ip (post или get)* — константа, имя операции;
 
 
 
type (post или get)* — принимает тип соединения:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;password — соединение при вводе пароля и логина;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key — соединение с приватным и публичным ключом.
 
 
 
При выборе password:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;passremote (post или get)* — пароль на удаленном сервере.
 
 
 
При выборе key:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key (post или get)* — приватный ключ через encodeURIComponent;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере.
 
 
 
ip (post или get)* ip-адрес удаленного сервера;
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
| style="vertical-align: top;" |  
 
error:0, mess:'Получение списка ip с удаленного хоста', detail[array_remote_ip];
 
 
 
error:100, mess:'Несоответствие типа';
 
 
 
error:101, mess:'Некорректный ip';
 
 
 
error:102, mess:'Не указан удаленный логин или пароль';
 
 
 
error:103, mess:'Не заполнены ip ключ или логин';
 
 
 
error:666, mess:'Вы пытаетесь проникнуть на запрещенную территорию';
 
 
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 121: Line 35:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Проверка соединения с удаленным сервером.
+
Checking the connection with the remote server.
  
 
connect
 
connect
  
| 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">connect (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection:</div> <div data-placeholder="Перевод" dir="ltr">password - connection when entering a password and login;</div> <div data-placeholder="Перевод" dir="ltr">key - connection with a private and public key.</div> <div data-placeholder="Перевод" dir="ltr">If password is selected:</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server;</div> <div data-placeholder="Перевод" dir="ltr">passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</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: 'The connection to the remote server has been established';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ip';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
transfer (post или get)* — константа, имя модуля;
 
 
 
connect (post или get)* — константа, имя операции;
 
 
 
type (post или get)* — принимает тип соединения:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;password — соединение при вводе пароля и логина;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key — соединение с приватным и публичным ключом.
 
 
 
При выборе password:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;passremote (post или get)* — пароль на удаленном сервере.
 
 
 
При выборе key:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key (post или get)* — приватный ключ через encodeURIComponent;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере.
 
 
 
ip (post или get)* ip-адрес удаленного сервера;
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
| style="vertical-align: top;" |  
 
error:0, mess:'Соединение с удаленным сервером установлено';
 
 
 
error:100, mess:'Несоответствие типа';
 
 
 
error:101, mess:'Некорректный ip';
 
 
 
error:666, mess:'Вы пытаетесь проникнуть на запрещенную территорию';
 
 
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 172: Line 46:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Сгенерировать и сохранить ключ на текущем сервере.
+
Generate and save key on the current server.
  
 
key
 
key
  
 +
| 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">command (post or get) * - command 2 of the save, generate parameter:</div> <div data-placeholder="Перевод" dir="ltr">generate - generates public and private keys;</div> <div data-placeholder="Перевод" dir="ltr">save - saves the public and private key.</div> <div data-placeholder="Перевод" dir="ltr">When choosing save 2 options:</div> <div data-placeholder="Перевод" dir="ltr">key - public key (post or get) * via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">private_key - private key (post or get) * via encodeURIComponent.</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: 'Request completed', detail [key, privat_key];</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'One of the values ​​of the private or public key is missing';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 +
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
username (post или get)* — имя пользователя;
+
transfer
 
 
password (post или get)* — пароль пользователя;
 
 
 
transfer (post или get)* — константа, имя модуля;
 
 
 
key (post или get)* — константа, имя операции;
 
 
 
command (post или get)* — команда 2 параметра save, generate:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;generate — генерирует публичный и приватный ключи;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;save — сохраняет публичный и приватный ключ.
 
 
 
При выборе save 2 параметра:
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key — публичный ключ (post или get)* через encodeURIComponent;
 
 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;private_key - приватный ключ (post или get)* через encodeURIComponent.
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
error:0, mess:'Запрос выполнен', detail [key,privat_key];
+
Transfer of account to remote server and vise versa.
  
error:102, mess:'Отсутствуют одно из значений приватный или публичный ключ';
+
start_trans
 
 
error:666, mess:'Вы пытаетесь проникнуть на запрещенную территорию';
 
 
 
error:400, 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">start_trans (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">typetrans (post or get) * - where to transfer accounts:</div> <div data-placeholder="Перевод" dir="ltr">fromremote - from a remote server;</div> <div data-placeholder="Перевод" dir="ltr">toremote - to a remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</div> <div data-placeholder="Перевод" dir="ltr">users_transfer [array] - an array of users or user (transfer via JSON.stringify);</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection.</div> <div data-placeholder="Перевод" dir="ltr">When choosing password:</div>
 +
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
<div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server;</div> <div data-placeholder="Перевод" dir="ltr">passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">domainsip (post or get) * - ip-address to which users are bound;</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: 'Request completed', detail [key, privat_key];</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid transport type' (fromremote, toremote);</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'Array of users was not transferred';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 105, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'One of the values ​​of the private or public key is missing';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 213: Line 70:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Перенос аккаунта с текущего сервера на удаленный и наоборот.
+
Transfer status.
  
start_trans
+
status_trans
  
| 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">status_trans (post or get) * - constant, operation name;</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: 'Request completed', detail [status_transfer];</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 +
|}
  
password (post или get)* — пароль пользователя;
+
Other useful articles:
  
transfer (post или get)* — константа, имя модуля;
+
{| style="width: 1061px;"
 +
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
start_trans (post или get)* — константа, имя операции;
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
typetrans (post или get)* — куда переносить аккаунты:
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fromremote — с удаленного сервера;
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;toremote — на удаленный сервер.
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
ip (post или get)* — ip-адрес удаленного сервера;
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
users_transfer[array] — массив пользователей или пользователя (передача через JSON.stringify);
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
type (post или get)* — принимает тип соединения.
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
При выборе password:
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере;
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;passremote (post или get)* — пароль на удаленном сервере.
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
При выборе key:
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key (post или get)* — &nbsp;приватный ключ через encodeURIComponent;
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loginremote (post или get)* — логин на удаленном сервере.
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
domainsip (post или get)* — ip-адрес, к которому привязываются пользователи;
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
| style="vertical-align: top;" |  
+
| style="width: 354px;" |  
error:0, mess:'Запрос выполнен', detail [key,privat_key];
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
error:101, mess:'Не соответствующий тип транспорта' (fromremote,toremote);
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
error:104, mess:'Не передан массив пользователей';
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
error:103, mess:'Не заполнены ip ключ или логин';
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
error:105, mess:'Не заполнены ip ключ или логин';
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
error:102, mess:'Отсутствуют одно из значений приватный или публичный ключ';
+
|-
 +
| style="width: 282px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
error:666, mess:'Вы пытаетесь проникнуть на запрещенную территорию';
+
| style="width: 354px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
error:400, mess:'К сожалению, модуль вам не доступен'.
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
| style="vertical-align: top;" |  
+
| style="width: 282px;" |  
transfer
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
| style="vertical-align: top;" |  
+
| style="width: 354px;" |  
Статус трансфера.
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
status_trans
+
| style="width: 403px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
| style="vertical-align: top;" |  
+
|-
username (post или get)* — имя пользователя;
+
| style="width: 282px;" |  
 
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
password (post или get)* — пароль пользователя;
 
 
 
transfer (post или get)* — константа, имя модуля;
 
 
 
status_trans (post или get)* — константа, имя операции;
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
  
| style="vertical-align: top;" |  
+
| style="width: 354px;" |  
error:0, mess:'Запрос выполнен', detail [status_transfer];
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
error:666, mess:'Вы пытаетесь проникнуть на запрещенную территорию';
+
| style="width: 403px;" |
 
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
error:400, mess:'К сожалению, модуль вам не доступен'.
 
  
 
|}
 
|}
 
&nbsp;
 

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

transfer

Display the list of host-accounts on the remote server.

list_user

username (post or get) * - username;
password (post or get) * - user password;
transfer (post or get) * - constant, module name;
list_user (post or get) * - constant, operation name;
type (post or get) * - accepts the type of connection:
password - connection when entering a password and login;
key - connection with a private and public key.
If password is selected:
loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server.
When selecting key:
key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server.
ip (post or get) * - ip-address of the remote server;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Getting the list of users from the remote host', detail [array_remote_host];
error: 100, mess: 'Type mismatch';
error: 101, mess: 'Invalid ip';
error: 102, mess: 'No remote login or password specified';
error: 103, mess: 'The ip key or login is not filled in';
error: 666, mess: 'You are trying to enter forbidden territory';
error: 400, mess: 'Unfortunately, the module is not available to you.'

transfer

getting the list of ip-addresses on the remote server.

list_ip

username (post or get) * - username;
password (post or get) * - user password;
transfer (post or get) * - constant, module name;
list_ip (post or get) * - constant, operation name;
type (post or get) * - accepts the type of connection:
password - connection when entering a password and login;
key - connection with a private and public key.
If password is selected:
loginremote (post or get) * - login on the remote server;
passremote (post or get) * - password on the remote server.
When selecting key:
key (post or get) * - private key via encodeURIComponent;
loginremote (post or get) * - login on the remote server.
ip (post or get) * - ip-address of the remote server;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Getting ip list from remote host', detail [array_remote_ip];
error: 100, mess: 'Type mismatch';
error: 101, mess: 'Invalid ip';
error: 102, mess: 'No remote login or password specified';
error: 103, mess: 'The ip key or login is not filled in';
error: 666, mess: 'You are trying to enter forbidden territory';
error: 400, mess: 'Unfortunately, the module is not available to you.'

transfer

Checking the connection with the remote server.

connect

username (post or get) * - username;
password (post or get) * - user password;
transfer (post or get) * - constant, module name;
connect (post or get) * - constant, operation name;
type (post or get) * - accepts the type of connection:
password - connection when entering a password and login;
key - connection with a private and public key.
If password is selected:
loginremote (post or get) * - login on the remote server;
passremote (post or get) * - password on the remote server.
When selecting key:
key (post or get) * - private key via encodeURIComponent;
loginremote (post or get) * - login on the remote server.
ip (post or get) * - ip-address of the remote server;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The connection to the remote server has been established';
error: 100, mess: 'Type mismatch';
error: 101, mess: 'Invalid ip';
error: 666, mess: 'You are trying to enter forbidden territory';
error: 400, mess: 'Unfortunately, the module is not available to you.'

transfer

Generate and save key on the current server.

key

username (post or get) * - username;
password (post or get) * - user password;
transfer (post or get) * - constant, module name;
key (post or get) * - constant, operation name;
command (post or get) * - command 2 of the save, generate parameter:
generate - generates public and private keys;
save - saves the public and private key.
When choosing save 2 options:
key - public key (post or get) * via encodeURIComponent;
private_key - private key (post or get) * via encodeURIComponent.
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Request completed', detail [key, privat_key];
error: 102, mess: 'One of the values ​​of the private or public key is missing';
error: 666, mess: 'You are trying to enter forbidden territory';
error: 400, mess: 'Unfortunately, the module is not available to you.'

transfer

Transfer of account to remote server and vise versa.

start_trans

username (post or get) * - username;
password (post or get) * - user password;
transfer (post or get) * - constant, module name;
start_trans (post or get) * - constant, operation name;
typetrans (post or get) * - where to transfer accounts:
fromremote - from a remote server;
toremote - to a remote server.
ip (post or get) * - ip-address of the remote server;
users_transfer [array] - an array of users or user (transfer via JSON.stringify);
type (post or get) * - accepts the type of connection.
When choosing password:

                           

loginremote (post or get) * - login on the remote server;
passremote (post or get) * - password on the remote server.
When selecting key:
key (post or get) * - private key via encodeURIComponent;
loginremote (post or get) * - login on the remote server.
domainsip (post or get) * - ip-address to which users are bound;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Request completed', detail [key, privat_key];
error: 101, mess: 'Invalid transport type' (fromremote, toremote);
error: 104, mess: 'Array of users was not transferred';
error: 103, mess: 'The ip key or login is not filled in';
error: 105, mess: 'The ip key or login is not filled in';
error: 102, mess: 'One of the values ​​of the private or public key is missing';
error: 666, mess: 'You are trying to enter forbidden territory';
error: 400, mess: 'Unfortunately, the module is not available to you.'

transfer

Transfer status.

status_trans

username (post or get) * - username;
password (post or get) * - user password;
transfer (post or get) * - constant, module name;
status_trans (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Request completed', detail [status_transfer];
error: 666, mess: 'You are trying to enter forbidden territory';
error: 400, mess: 'Unfortunately, the module is not available to 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