API: User Certificates
Администраторские функции требуют 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:1000, 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:1000, 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:1000, mess:'У вас нет прав администратора'; error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'. |
|
certs_control |
Добавление ключа и сертификата к домену. savedomaincerts |
username (post)* — имя пользователя; password (post)* — пароль пользователя; certs_control (post)* — константа, имя модуля; savedomaincerts (post)* — константа, тип операции; domain (post)* — домен для которого применяется сертификат; key (post)* — ключ который применяется к домену. Или указать опцию 'letencrypt' для генерации ключа этого типа; key_mail (post) — применить ключ для почты: yes/no (по умолчанию - no). |
error:0, mess:'Сертификат біл установлен для домена: <domain>'; error:5, mess:'Ошибка в блоке параметров'; error:1000, mess:'У вас нет прав администратора'; error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'. |
|
certs_control |
Получить список доменов с сертификатами. |
username (post)* — имя пользователя; password (post)* — пароль пользователя; certs_control (post)* — константа, имя модуля; listdomaincerts (post)* — константа, тип операции; language (post) — может принимать значение: en/ru (по умолчанию ru); panel_user (post) — имя пользователя ISP, к которому применяется операция. |
error:0, mess:'Список доменов использующие сертификаты был получен для пользователя: <name>', data: содержит список доменов; error:5, mess:'Ошибка в блоке параметров'; error:1000, 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:1000, mess:'У вас нет прав администратора'; error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'. |
Другие полезные статьи:
