API: пользовательские сертификаты — различия между версиями

Материал из BrainyCP
Перейти к: навигация, поиск
 
(не показаны 4 промежуточные версии 2 участников)
Строка 38: Строка 38:
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
−
 
−
error:1000, mess:'У вас нет прав администратора';
 
  
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
Строка 75: Строка 73:
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
−
 
−
error:1000, mess:'У вас нет прав администратора';
 
  
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
Строка 122: Строка 118:
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
−
 
−
error:1000, mess:'У вас нет прав администратора';
 
  
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
Строка 132: Строка 126:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Добавление ключа и сертификата к домену.
+
Установка сертификата&nbsp;letsencrypt
  
−
savedomaincerts
+
create_letsencert_domain
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Строка 143: Строка 137:
 
certs_control (post)* — константа, имя модуля;
 
certs_control (post)* — константа, имя модуля;
  
−
savedomaincerts (post)* — константа, тип операции;
+
create_letsencert_domain(post)* — константа, тип операции;
  
 
domain (post)* — домен для которого применяется сертификат;
 
domain (post)* — домен для которого применяется сертификат;
  
−
key (post)* — ключ который применяется к домену. Или указать опцию 'letencrypt' для генерации ключа этого типа;
+
autorenew (post)* — автопродление: yes/no (по умолчанию - no).
  
 
key_mail (post) — применить ключ для почты: yes/no (по умолчанию - no).
 
key_mail (post) — применить ключ для почты: yes/no (по умолчанию - no).
 +
 +
panel_user (post)* — Пользователь которому принадлежит сайт&nbsp;(по умолчанию - хостаккаунт на котором панель).
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Строка 155: Строка 151:
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
−
 
−
error:1000, mess:'У вас нет прав администратора';
 
  
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
Строка 165: Строка 159:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Получить список доменов с сертификатами.
+
Добавление ключа и сертификата к домену.
 +
 
 +
savedomaincerts
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Строка 174: Строка 170:
 
certs_control (post)* — константа, имя модуля;
 
certs_control (post)* — константа, имя модуля;
  
−
listdomaincerts (post)* — константа, тип операции;
+
savedomaincerts (post)* — константа, тип операции;
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
domain (post)* — домен для которого применяется сертификат;
 +
 
 +
key (post)* — ключ который применяется к домену.
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
key_mail (post) — применить ключ для почты: yes/no (по умолчанию - no).
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
error:0, mess:'Список доменов использующие сертификаты был получен для пользователя: <name>', data: содержит список доменов;
+
error:0, mess:'Сертификат біл установлен для домена: <domain>';
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
−
 
−
error:1000, mess:'У вас нет прав администратора';
 
  
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
Строка 219: Строка 215:
  
 
error:5, mess:'Ошибка в блоке параметров';
 
error:5, mess:'Ошибка в блоке параметров';
−
 
−
error:1000, mess:'У вас нет прав администратора';
 
  
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.

Текущая версия на 15:26, 27 июля 2021

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

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

Модуль

Функция

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

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

certs_control

Просмотр сертификатов пользователя.

listcerts

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

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

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

listcerts (post)* — константа, тип операции;

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

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

error:0, mess:'Список сертификатов был успешно получен для пользователя: <name>', data: содержит список сертификатов;

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

error:5, mess:'Ошибка в блоке параметров';

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

certs_control

Удалить сертификат и ключ.

delcerts

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

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

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

delcerts (post)* — константа, тип операции;

key_name (post)* — имя для удаления;

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

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

error:0, mess:'Ключ и сертификат были успешно удалены для пользователя: <name>';

error:1, mess:'Требуемый сертификат не может быть удален так как он используется';

error:2, mess:'Нет такого ключа и сертификата. Нечего удалять';

error:5, mess:'Ошибка в блоке параметров';

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

certs_control

Создание ключа и сертификата.

addcerts

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

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

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

addcerts (post)* — константа, тип операции;

key_size (post) — размер ключа (по умолчанию 2048; может быть 4096);

domain (post)* — домен, для которого применяется сертификат;

country (post)* — страна (определяется двумя символами; по умолчанию 'ru');

state (post)* — штат (строковая переменная);

city (post)* — город (строковая переменная);

company (post)* — компания (строковая переменная);

division (post)* — отдел (строковая переменная);

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

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

error:0, mess:'Новый сертификат был успешно добавлен для пользователя: <name>', data: содержит имя нового ключа и сертификата;

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

error:5, mess:'Ошибка в блоке параметров';

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

certs_control

Установка сертификата letsencrypt

create_letsencert_domain

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

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

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

create_letsencert_domain(post)* — константа, тип операции;

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

autorenew (post)* — автопродление: yes/no (по умолчанию - no).

key_mail (post) — применить ключ для почты: yes/no (по умолчанию - no).

panel_user (post)* — Пользователь которому принадлежит сайт (по умолчанию - хостаккаунт на котором панель).

error:0, mess:'Сертификат біл установлен для домена: <domain>';

error:5, mess:'Ошибка в блоке параметров';

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

certs_control

Добавление ключа и сертификата к домену.

savedomaincerts

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

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

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

savedomaincerts (post)* — константа, тип операции;

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

key (post)* — ключ который применяется к домену.

key_mail (post) — применить ключ для почты: yes/no (по умолчанию - no).

error:0, mess:'Сертификат біл установлен для домена: <domain>';

error:5, mess:'Ошибка в блоке параметров';

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

certs_control

Удалить сертификат с домена.

deldomaincerts

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

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

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

deldomaincerts(post)* — константа, тип операции;

domain (post)* — домен для которого удаляется сертификат;

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

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

error:0, mess:'Сертификат был убран с домена';

error:1, mess:'Ошибка, такой домен не найден или не содержит никакого сертификата';

error:5, mess:'Ошибка в блоке параметров';

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

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

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

Источник — «https://docs.brainycp.com/index.php?title=API:_пользовательские_сертификаты&oldid=1040»