API: host-accounts

From BrainyCP
Revision as of 09:58, 15 April 2019 by Aglions (talk | contribs)

Jump to: navigation, search

Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.

Входящие данные, отмеченные звездочкой, обязательны для заполнения. 

Модуль

Функция

Входящие данные

Варианты ошибок

hostacc

Просмотр данных хост аккаунта (можно без api_full, но только если юзейрнейм хост-аккаунта совпадает).

getlistacc
 

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

getlistacc (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru);

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Информация была успешно получена';

error:1, mess:'Произошла ошибка при получении данных';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

hostacc

Смена шелл-доступа для аккаунта (можно без api_full, но только если юзейрнейм хост-аккаунта совпадает).

changeshellacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

changeshellacc (post или get)* — константа, имя операции;     

shell (post или get)* — включить/выключить шел доступ (может принимать значения yes/no);

language (post или get) — может принимать значение: en/ru (по умолчанию ru);

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Доступ к шеллу был успешно изменен. Текущее значение: вкл./выкл';

error:1, mess:'Произошла ошибка при попытке изменения доступа к шелу';

error:2, mess:'Параметр shell содержит недопустимое значение. Возможные значения: yes/no';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

hostacc

Смена языка для аккаунта  (можно без api_full, но только если юзейрнейм хост-аккаунта совпадает).

changelangacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

changelangacc (post или get)* — константа, имя операции;     

lang (post или get)* - изменить язык (может принимать значения en/ru);

language (post или get) — может принимать значение: en/ru (по умолчанию ru);

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

 

error:0, mess:'Выбранный язык был успешно установлен, текущий: ru/en';

error:1, mess:'Произошла ошибка при попытке смены языка';

error:2, mess:'Параметр lang содержит недопустимое значение. Возможные значения: ru/en';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

hostacc

Редактирование хост-аккаунта (только с включенным apifull).

edituseracc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

edituseracc (post или get)* — константа, имя операции;

lg (post или get) — имя пользователя;

    ps (post или get) — изменить пароль;

    ip (post или get) — изменить или добавить IP (перечисляются через запятую);

    group (post или get) — изменить группу;

    plan (post или get) — изменить план;

    lang (post или get) — изменить язык;

    emailboxes (post или get) — изменить количество почтовых ящиков;

    bandwidth (post или get) — изменить трафик, указывается в Мб;

    sites (post или get) — изменить количество сайтов;

    databases (post или get) — изменить число баз mysql;

    subdomains (post или get) — изменить количество субдоменов;

    mailperhour (post или get) — изменить количество писем в час;

    disk (post или get) — изменить размер дискового пространства (указывается в Мб);

    ftp_accounts (post или get) — изменить количество ftp аккаунтов;

    shell_access (post или get) — шел доступ, может быть n/y;

    owner (post или get) — изменить владельца.

language (post или get) — может принимать значение: en/ru (по умолчанию ru);

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Новые параметры для пользователя были успешно применены';

error:1, mess:'Произошла ошибка при изменении параметров для пользователя: <username>';

error:2, mess:'Ни одной группы не было найдено';

error:3, mess:'Указанной группы для этого пользователя не существует';

error:4, mess:'Имя логина должно содержать не менее 4 символов';

error:5, mess:'Новый пароль должен содержать не менее 7 символов';

error:6, mess:'Значение shell содержит некорректное значение. Допустимо y/n';

error:7, mess:'Ни одного плана не было найдено';

error:8, mess:'Указанного плана для этого пользователя не существует';

error:9, mess:'Указан некорректный язык. Допустимые значения ru/en';

error:10, mess:'<params_name> - допускаются только цифры 0-9';

error:11, mess:'Указанный ip-адрес некорректный';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели';

error:1003, mess:'У вас нет прав администратора';

error:100, mess:'У вас нет прав выполнить эту операцию'.

hostacc

Удаление хост-аккаунта (только с включенным apifull).

deluseracc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

deluseracc (post или get)* — константа, имя операции;     

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Пользователь был успешно удален';

error:1, mess:'Произошла ошибка при удалении пользователя';

error:2, mess:'Такого пользователя нет в системе';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели';

error:1003, mess:'У вас нет прав администратора';

error:100, mess:'У вас нет прав выполнить эту операцию'.

hostacc

Блокировка хост аккаунта полностью и частично (только с включенным apifull).

suspendacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

suspendacc (post или get)* — константа, имя операции;

action — параметр, тип блокировки

  • suspend_ftp (post или get) — блокировать ftp;
  • suspend_sites (post или get) — блокировать сайты;
  • suspend_shell (post или get) — блокировать шел;
  • suspend_cron (post или get) — блокировать крон;
  • suspend_panel (post или get) — блокировать ранель;
  • suspend_full (post или get) — блокировать полностью

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Блокировки были успешно применены для пользователя: <username>';

error:1, mess:'Нечего блокировать для пользователя: <username>';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели';

error:1003, mess:'У вас нет прав администратора'.
 

hostacc

Разблокировка хост-аккаунта (только с включенным apifull).

unsuspendacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

unsuspendacc (post или get)* — константа, имя операции;

action — параметр, тип разблокировки

  • unsuspend_ftp (post или get) — разблокировать ftp;
  • unsuspend_sites (post или get) — разблокировать сайты;
  • unsuspend_shell (post или get) — разблокировать шел;
  • unsuspend_cron (post или get) — разблокировать крон;
  • unsuspend_panel (post или get) — разблокировать ранель;
  • unsuspend_full (post или get) — разблокировать полностью

panel_user (post или get) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Разблокировка были успешно применена для пользователя: <username>';

error:1, mess:'Нечего разблокировать для пользователя: <username>';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели';

error:1003, mess:'У вас нет прав администратора'.

 

hostacc

Список хост-аккаунтов (только с включенным apifull).

listuseracc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

listuseracc (post или get)* — константа, имя операции.

error:0, mess:'Список пользователей был успешно получен';

error:1, mess:'Ни одного пользователя не было найдено';

error:1003, mess:'У вас нет прав администратора'.

hostacc

Создание хост-аккаунта (только с включенным apifull).

adduseracc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

adduseracc (post или get)* — константа, имя операции;

$lg (post или get)* — имя нового пользователя;

$ps (post или get)* — пароль нового пользователя;

plan (post или get)* — имя тарифного плана;

group (post или get)* — имя группы;

ip (post или get)* — изменить или добавить IP (перечисляются через запятую).

error:0, mess:'Новый пользователь был успешно добавлен';

error:1, mess:'Произошла ошибка при добавлении нового пользователя';

error:2, mess:'Указанная группа не найдена';

error:3, mess:'Указанный тарифный план не найден';

error:4, mess:'Имя логина должно содержать не менее 4 символов';

error:5, mess:'Пароль должен содержать не менее 7 символов';

error:1003, mess:'У вас нет прав администратора'.

 

hostacc

Список тарифов (только с включенным apifull).

listplanacc
 

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

listplanacc (post или get)* — константа, имя операции.

error:0, mess:'Список тарифных планов был успешно получен';

error:1, mess:'Ни одной тарифного плана не было обнаружено';

error:1003, mess:'У вас нет прав администратора'.

hostacc

Просмотр тарифа (только с включенным apifull).

viewplanacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

viewplanacc (post или get)* — константа, имя операции;

plan (post или get)* — имя тарифного плана.

error:0, mess:'Данные о тарифном плане были успешно получены';

error:1, mess:'Произошла ошибка при получении данных о тарифном плане';

error:2, mess:'Указанного тарифного плана не существует';

error:3, mess:'Не указано имя тарифного плана'.

hostacc

Рредактирование тарифа (только с включенным apifull).

editplanacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

editplanacc (post или get)* — константа, имя операции;

plan (post или get)* — имя тарифного плана для редактирования;

bandwidth (post или get) — пропускная способность в Мб;

disk (post или get) — велечина дискового пространства в Мб;

sites (post или get) — количество сайтов;

subdomains (post или get) — количество поддоменов;

databases (post или get) — количество баз mysql;

emailboxes (post или get) — число почтовых ящиков;

mailperhour (post или get) — количество писем в час;

ftp_accounts (post или get) — число аккаунотов ftp;

shell (post или get) — доступность шела - y/n;

owner (post или get) — владелец;

lang (post или get) — язык (ru/en).

error:0, mess:'Тарифный план был успешно отредактирован';

error:1, mess:'Произошла ошибка при редактировании тарифного плана';

error:2, mess:'Указанного тарифного плана не существует';

error:3, mess:'Значение shell содержит некорректное значение. Допустимо y/n';

error:4, mess:'Указан некорректный язык. Допустимые значения ru/en';

error:10, mess:'<params_name> - допускаются только цифры 0-9';

error:1003, mess:'У вас нет прав администратора';

error:101, mess:'У вас нет прав выполнить эту операцию'.

hostacc

Добавление тарифа (только с включенным apifull).

addplanacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

addplanacc (post или get)* — константа, имя операции;

plan (post или get)* — имя нового тарифного плана;

bandwidth (post или get)* — пропускная способность в Мб;

disk (post или get)* — велечина дискового пространства в Мб;

sites (post или get)* — количество сайтов;

subdomains (post или get)* — количество поддоменов;

databases (post или get)* — количество баз mysql;

emailboxes (post или get)* — число почтовых ящиков;

mailperhour (post или get)* — количество писем в час;

ftp_accounts (post или get)* — число аккаунотов ftp;

shell (post или get)* — доступность шела (y/n);

owner (post или get) — владелец (по умолчанию " ");

lang (post или get) — язык (ru/en).

 

error:0, mess:'Новый тарифный план был успешно создан';

error:1, mess:'Произошла ошибка при создании нового тарифного плана';

error:2, mess:'Такой тарифный план уже существует';

error:3, mess:'Задано некорректное имя нового тарифного плана';

error:4, mess:'Значение shell содержит некорректное значение. Допустимо y/n';

error:5, mess:'Указан некорректный язык. Допустимые значения ru/en';

error:10, mess:'<params_name> - допускаются только цифры 0-9';

error:1003, mess:'У вас нет прав администратора';

error:101, mess:'У вас нет прав выполнить эту операцию'.

hostacc

Удаление тарифа (только с включенным apifull).

delplanacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

delplanacc(post или get)* — константа, имя операции;

plan (post или get)* — имя нового тарифного плана для удаления.

error:0, mess:'Тарифный план был успешно удален';

error:1, mess:'Произошла ошибка при удалении тарифного плана';

error:2, mess:'Такого тарифного плана не существует';

error:3, mess:'Не указано имя тарифного плана для удаления';

error:1003, mess:'У вас нет прав администратора';

error:101, mess:'У вас нет прав выполнить эту операцию'.

hostacc

Список групп (только с включенным apifull).

listgroupacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

listgroupacc (post или get)* — константа, имя операции.

error:0, mess:'Список групп был успешно получен';

error:1, mess:'Ни одной группы не было обнаружено';

error:1003, mess:'У вас нет прав администратора'.

hostacc

Просмотр группы (только с включенным apifull).

viewgroupacc

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

viewgroupacc (post или get)* — константа, имя операции;

group (post или get)* — имя группы.

error:0, mess:'Данные о группе были успешно получены';

error:1, mess:'Произошла ошибка при получении данных о группе; '<groupname>;

error:1003, mess:'У вас нет прав администратора'.
 

hostacc

Добавление группы (только с включенным apifull).

addgroupacc

 

group (post или get)* — имя группы;

root (post или get) — доступ root;

ftp_restart (post или get) — перезагрузка ftp;

ftp_install (post или get) — переустановка ftp;

reseller (post или get) — посредник;

reseller_planview (post или get) — просматривать план посреднику;

reseller_groupview (post или get) — просматривать группу посреднику;

reseller_groupcreate (post или get) — создавать группу посреднику;

reseller_plancreate (post или get) — создовать план посреднику;

api (post или get) — доступ по API;

apifull (post или get) — полный доступ по API(администратор).

error:0, mess:'Новая группа была успешно добавлена';

error:1, mess:'Произошла ошибка при добавлении новой группы';

error:2, mess:'Такая группа уже существует';

error:3, mess:'Задано некорректное значение новой группы';

error:4, mess:'<paramname> -  параметр задан некорректно. Может быть y/n/"" (пустая строка)';

error:1003, mess:'У вас нет прав администратора'.
 

hostacc

Редактирование группы (только с включенным apifull).

editgroupacc

group (post или get)* — имя группы;

root (post или get) — доступ root;

ftp_restart (post или get) — перезагрузка ftp;

ftp_install (post или get) — переустановка ftp;

reseller (post или get) — посредник;

reseller_planview (post или get) — просматривать план посреднику;

reseller_groupview (post или get) — просматривать группу посреднику;

reseller_groupcreate (post или get) — создавать группу посреднику;

reseller_plancreate (post или get) — создовать план посреднику;

api (post или get) — доступ по API;

apifull (post или get) — полный доступ по API(администратор).

error:0, mess:'Группа была успешно отредактирована';

error:1, mess:'Произошла ошибка при редактировании группы';;

error:2, mess:'Указанная группа не была найдена или не определена'

error:3, mess:'<paramname> -  параметр задан некорректно. Может быть y/n/"" (пустая строка)';

error:1003, mess:'У вас нет прав администратора'.
 

hostacc

Удаление группы (только с включенным apifull).

delgroupacc
 

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

hostacc (post или get)* — константа, имя модуля;

delgroupacc (post или get)* — константа, имя операции;

group (post или get)* — имя группы.

error:0, mess:'Группа была успешно удалена';

error:1, mess:'Произошла ошибка при удалении группы';

error:2, mess:'Такой группы не существует';

error:3, mess:'Имя группы не определено или некорректно';

error:1003, mess:'У вас нет прав администратора'.

Другие полезные статьи:

API: подключение

API: мониторинг

API: статус веб-сервера

API: автоустановщик CMS

API: настройка бекапов

API: трансфер между серверами

API: антивирус

API: настройки сервера

API: управление веб-сервером

API: базы данных

API: пользовательские сертификаты

API: управление почтовыми ящиками

API: информация о сервере

API: почта

API: управление DNS-зонами

API: использование трафика

API: почтовые ящики клиента

API: установка веб-сервера

API: логирование

API: сервер имен

API: хост-аккаунты

API: менеджер приложений

API: сертификаты сервисов

API: CRON

API: менеджер процессов

API: сетевые инструменты

API: FTP-сервер

API: менеджер IP-адресов

API: средняя нагрузка

API: MySQL processlist

Retrieved from "https://docs.brainycp.io/index.php?title=API:_host-accounts&oldid=455"