Difference between revisions of "API: Manage webserver"

From BrainyCP
Jump to: navigation, search
 
(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;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Setting a password for a directory.</div>
−
Установка пароля на директорию.
 
−
 
 
 
set_password
 
set_password
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">set_password (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">directory (post or get) * - directory;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - password directory;</div> <div data-placeholder="Перевод" dir="ltr">user_login(post) * - login directory;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Success';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'The directory does not exist or the format is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'Weak password';</div> <div data-placeholder="Перевод" dir="ltr">error: -2, mess: 'The password for this folder already exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
set_password (post или get)* — константа, имя операции;
 
−
 
 
−
directory (post или get)* — директория;
 
−
 
 
−
password (post)* — пароль;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Успешно';
 
−
 
 
−
error:-1, mess:'Директории не существует или неверный формат';
 
−
 
 
−
error:-1, mess:'Слабый пароль';
 
−
 
 
−
error:-2, mess:'Пароль на данную папку уже существует';
 
−
 
 
−
error:400, mess:'У вас не достаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Removing a directory</div>
−
Удаление директории.
+
.
  
 
delete_password
 
delete_password
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_password (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">directory (post or get) * - directory;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Success';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'Not completed';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The directory does not exist or the format is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
delete_password (post или get)* — константа, имя операции;
 
−
 
 
−
directory (post или get)* — директория;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Успешно';
 
−
 
 
−
error:-1, mess:'Не выполнено';
 
−
 
 
−
error:100, mess:'Директории не существует или неверный формат';
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Browse password-protected directories.</div>
−
Просмотр запароленных директорий.
 
−
 
 
 
list_directory
 
list_directory
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_directory (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'List of password-protected directories', detail [array_directory];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The list of password-protected directories is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_directory (post или get)* — константа, имя операции;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список запароленных директорий',detail[array_directory];
 
−
 
 
−
error:100, mess:'Список запароленных директорий пуст';
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Redirect from http to https / https to http.</div>
−
Переадресация с http на https/https на http.
 
−
 
 
 
add_http
 
add_http
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_http (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">site (post or get) * - domain for redirection;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - type of redirection (http, https);</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Forwarding added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'This type of forwarding already exists;</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'A redirect already exists for this site .;</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This is not yours', detail [list_domain;</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Non-existent type', detail [array_type];</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
add_http (post или get)* — константа, имя операции;
 
−
 
 
−
site (post или get)* — домен для переадресации;
 
−
 
 
−
type (post или get)* — тип переадресациии(http, https);
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Переадресация успешно добавлена';
 
−
 
 
−
error:-1, mess:'Такой тип переадресации уже существует'';''
 
−
 
 
−
error:-1, mess:'Переадресация для данного сайта уже существует.'';''
 
−
 
 
−
error:100, mess:'Это не ваше', detail[list_domain;
 
−
 
 
−
error:101, mess:'Несуществующий тип', detail[array_type];
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Show list of sites.</div>
−
Показать список сайтов.
 
−
 
 
 
list_http
 
list_http
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_http (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'List of domains', detail [array_domain];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The list of domains is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_http (post или get)* — константа, имя операции;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список доменов',detail[array_domain];
 
−
 
 
−
error:100, mess:'Список доменов пуст';
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Listing directories.</div>
−
Вывод списка директорий.
 
−
 
 
 
list_directory_http
 
list_directory_http
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
username (post or get) * - username;
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_directory_http (post или get)* — константа, имя операции;
 
  
−
user_edit (post или get) — имя редактируемого пользователя;
+
password (post or get) * - user password;
  
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
+
apacserver (post or get) * - constant, module name;
  
−
| style="vertical-align: top;" |
+
list_directory_http (post or get) * - constant, operation name;
−
error:0, mess:'Список Директорий',detail[array_directory];
 
  
−
error:100, mess:'Список Директорий пуст';
+
user_edit (post or get) - the name of the user being edited;
  
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
+
language (post or get) - can take the value: en / ru (ru by default).
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'List of Directories', detail [array_directory];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Directory List is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 211: Line 79:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удалить директорию.
+
Delete directory.
  
 
delete_http
 
delete_http
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_http (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">site (post or get) * - domain (redirect to be deleted);</div> <div data-placeholder="Перевод" dir="ltr">uniq_id (post or get) * - unique identifier;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Forwarding successfully deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'There are no rights for this operation!';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This is not yours';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
delete_http (post или get)* — константа, имя операции;
 
−
 
 
−
site (post или get)* — домен (переадресация, которую нужно удалить);
 
−
 
 
−
uniq_id (post или get)* — уникальный идентификатор;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Переадресация успешно удалена';
 
−
 
 
−
error:-1, mess:'Нет прав для данной операции!';
 
−
 
 
−
error:100, mess:'Это не ваше';
 
−
 
 
−
error:400, message:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
apacserver
 
apacserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Display a list of redirects.</div>
−
Вывод списка переадресаций.
 
−
 
 
 
list_www
 
list_www
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_www (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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, message: 'Forwarding list', detail [array_forwarding];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, message: 'The forwarding list is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_www (post или get)* — константа, имя операции;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, message:'Список переадресаций',detail[array_forwarding];
 
−
 
 
−
error:100, message:'Список переадресаций пуст';
 
−
 
 
−
error:400, message:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 275: Line 99:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удалить переадресацию.
+
Delete redirect
  
 
delete_www
 
delete_www
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_www (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">uniq_id (post or get) * - uical identifier (needed for deletion);</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Forwarding successfully deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'There are no rights for this operation!';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The unic_id was entered incorrectly. Or this redirection is no longer there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
delete_www (post или get)* — константа, имя операции;
 
−
 
 
−
uniq_id (post или get)* — уикальный идентификатор(нужен для удаления);
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Переадресация успешно удалена';
 
−
 
 
−
error:-1, mess:'Нет прав для данной операции!';
 
−
 
 
−
error:100, mess:'unic_id введен не правильно. Или этой переадресации уже нет';
 
−
 
 
−
error:400, mess:'У вас недостаточно прав. Уберите user_edit'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 308: Line 110:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Веб-переадресация.
+
Web-redirect
  
 
add_www
 
add_www
  
−
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_www (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">domain (post) * - domain;</div> <div data-placeholder="Перевод" dir="ltr">select_www (post or get) * - redirect method;</div> <div data-placeholder="Перевод" dir="ltr">site_forwarding (post) * - where the redirect leads;</div> <div data-placeholder="Перевод" dir="ltr">src (post or get) * - path for forwarding;</div> <div data-placeholder="Перевод" dir="ltr">draft (post or get) - false by default;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</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: 'Forwarding added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'This type of forwarding already exists';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'Invalid destination format';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'Invalid site name format';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'There are no rights for this operation!';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Domain does not exist.', detail [array_list_domain];</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Forwarding assigned incorrectly', detail [array_list_forwarding];</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'No forwarding path specified'.</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
apacserver (post или get)* — константа, имя модуля;
 
−
 
 
−
add_www (post или get)* — константа, имя операции;
 
−
 
 
−
domain (post)* — домен;
 
−
 
 
−
select_www (post или get)* — метод переадресации;
 
−
 
 
−
site_forwarding (post)* — куда ведет переадресация;
 
−
 
 
−
src (post или get)* — путь для переадресации;
 
−
 
 
−
draft (post или get) — по умолчанию false;
 
−
 
 
−
user_edit (post или get) — имя редактируемого пользователя;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Переадресация успешно добавлена';
 
−
 
 
−
error:-1, mess:'Такой тип переадресации уже существует';
 
−
 
 
−
error:-1, mess:'Неверный формат назначения';
 
−
 
 
−
error:-1, mess:'Неверный формат имени сайта';
 
−
 
 
−
error:-1, mess:'Нет прав для данной операции!';
 
−
 
 
−
error:101, mess:'Не существующий домен.',detail[array_list_domain];
 
−
 
 
−
error:102, mess:'Не правильно назначена переадресация',detail[array_list_forwarding];
 
−
 
 
−
error:103, mess:'Не указан путь переадресации'.
 
−
 
 
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1237px;"
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 330px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
|  
+
| style="width: 454px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 431px;" |  
−
'''[https://docs.brainycp.ru/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 13:57, 18 August 2023

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

apacserver

Setting a password for a directory.

set_password

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
set_password (post or get) * - constant, operation name;
directory (post or get) * - directory;
password (post) * - password directory;
user_login(post) * - login directory;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Success';
error: -1, mess: 'The directory does not exist or the format is invalid';
error: -1, mess: 'Weak password';
error: -2, mess: 'The password for this folder already exists';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Removing a directory

.

delete_password

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
delete_password (post or get) * - constant, operation name;
directory (post or get) * - directory;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Success';
error: -1, mess: 'Not completed';
error: 100, mess: 'The directory does not exist or the format is invalid';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Browse password-protected directories.

list_directory

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
list_directory (post or get) * - constant, operation name;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'List of password-protected directories', detail [array_directory];
error: 100, mess: 'The list of password-protected directories is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Redirect from http to https / https to http.

add_http

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
add_http (post or get) * - constant, operation name;
site (post or get) * - domain for redirection;
type (post or get) * - type of redirection (http, https);
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Forwarding added successfully';
error: -1, mess: 'This type of forwarding already exists;
error: -1, mess: 'A redirect already exists for this site .;
error: 100, mess: 'This is not yours', detail [list_domain;
error: 101, mess: 'Non-existent type', detail [array_type];
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Show list of sites.

list_http

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
list_http (post or get) * - constant, operation name;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'List of domains', detail [array_domain];
error: 100, mess: 'The list of domains is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Listing directories.

list_directory_http

username (post or get) * - username;

password (post or get) * - user password;

apacserver (post or get) * - constant, module name;

list_directory_http (post or get) * - constant, operation name;

user_edit (post or get) - the name of the user being edited;

language (post or get) - can take the value: en / ru (ru by default).

error: 0, mess: 'List of Directories', detail [array_directory];
error: 100, mess: 'Directory List is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Delete directory.

delete_http

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
delete_http (post or get) * - constant, operation name;
site (post or get) * - domain (redirect to be deleted);
uniq_id (post or get) * - unique identifier;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Forwarding successfully deleted';
error: -1, mess: 'There are no rights for this operation!';
error: 100, mess: 'This is not yours';
error: 400, message: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Display a list of redirects.

list_www

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
list_www (post or get) * - constant, operation name;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, message: 'Forwarding list', detail [array_forwarding];
error: 100, message: 'The forwarding list is empty';
error: 400, message: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Delete redirect

delete_www

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
delete_www (post or get) * - constant, operation name;
uniq_id (post or get) * - uical identifier (needed for deletion);
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Forwarding successfully deleted';
error: -1, mess: 'There are no rights for this operation!';
error: 100, mess: 'The unic_id was entered incorrectly. Or this redirection is no longer there ';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Web-redirect

add_www

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
add_www (post or get) * - constant, operation name;
domain (post) * - domain;
select_www (post or get) * - redirect method;
site_forwarding (post) * - where the redirect leads;
src (post or get) * - path for forwarding;
draft (post or get) - false by default;
user_edit (post or get) - the name of the user being edited;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Forwarding added successfully';
error: -1, mess: 'This type of forwarding already exists';
error: -1, mess: 'Invalid destination format';
error: -1, mess: 'Invalid site name format';
error: -1, mess: 'There are no rights for this operation!';
error: 101, mess: 'Domain does not exist.', detail [array_list_domain];
error: 102, mess: 'Forwarding assigned incorrectly', detail [array_list_forwarding];
error: 103, mess: 'No forwarding path specified'.

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:_Manage_webserver&oldid=334633"