View source for API: User Certificates


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

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

{| border="1" cellpadding="5"
|-
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p> 
| <p dir="ltr" style="text-align: center;">'''Функция'''</p> 
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p> 
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p> 
|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Просмотр сертификатов пользователя.

listcerts

| style="vertical-align: top;" | 
username (post)* — имя пользователя;

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

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

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

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

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

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

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

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

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

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

|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Удалить сертификат и ключ.

delcerts

| style="vertical-align: top;" | 
username (post)* — имя пользователя;

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

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

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

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

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

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

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

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

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

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

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

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

|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Создание ключа и сертификата.

addcerts

| style="vertical-align: top;" | 
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, к которому применяется операция.

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

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

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

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

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

|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Добавление ключа и сертификата к домену.

savedomaincerts

| style="vertical-align: top;" | 
username (post)* — имя пользователя;

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

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

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

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

key (post)* — ключ который применяется к домену. Или указать опцию 'letencrypt' для генерации ключа этого типа;

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

| style="vertical-align: top;" | 
error:0, mess:'Сертификат біл установлен для домена: <domain>';

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

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

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

|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Получить список доменов с сертификатами.

| style="vertical-align: top;" | 
username (post)* — имя пользователя;

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

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

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

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

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

| style="vertical-align: top;" | 
error:0, mess:'Список доменов использующие сертификаты был получен для пользователя: <name>', data: содержит список доменов;

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

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

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

|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Удалить сертификат с домена.

deldomaincerts

| style="vertical-align: top;" | 
username (post)* — имя пользователя;

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

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

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

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

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

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

| style="vertical-align: top;" | 
error:0, mess:'Сертификат был убран с домена';

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

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

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

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

|}

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

{| style="width: 1191px;"
|-
| 
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''

| 
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''

| 
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''

| 
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''

| 
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''

| 
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''

| 
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''

| 
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''

| 
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''

| 
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''

| 
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''

| 
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''

| 
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''

| 
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''

| 
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''

| 
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''

| 
'''[https://docs.brainycp.io/index.php/API:_CRON API: CRON]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''

| 
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''

| 
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''

|-
| 
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''

| 
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''

| 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist API: MySQL processlist]'''

|}