Difference between revisions of "API: User Certificates"

From BrainyCP
Jump to: navigation, search
m (Fgsfds переименовал страницу API: пользовательские сертификаты в API: User Certificates)
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;" |  
Line 15: Line 11:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Просмотр сертификатов пользователя.
+
Show user certificates.
  
 
listcerts
 
listcerts
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">listcerts (post) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div>
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post)* — имя пользователя;
+
error: 0, mess: 'The list of certificates was successfully received for the user: <name>', data: contains the list of certificates;
−
 
 
−
password (post)* — пароль пользователя;
 
  
−
certs_control (post)* — константа, имя модуля;
+
error: 1, mess: 'There was an error getting the list of certificates for the user: <name>';
  
−
listcerts (post)* — константа, тип операции;
+
error: 5, mess: 'Error in the parameter block';
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
error: 1000, mess: 'You do not have administrator rights';
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.
−
 
 
−
| style="vertical-align: top;" |
 
−
error:0, mess:'Список сертификатов был успешно получен для пользователя: <name>', data: содержит список сертификатов;
 
−
 
 
−
error:1, mess:'Произошла ошибка получения списка сертификатов для пользователя: <name>';
 
−
 
 
−
error:5, mess:'Ошибка в блоке параметров';
 
−
 
 
−
error:1000, mess:'У вас нет прав администратора';
 
−
 
 
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
 
  
 
|-
 
|-
Line 48: Line 32:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удалить сертификат и ключ.
+
Delete certificate and key.
  
 
delcerts
 
delcerts
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delcerts (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">key_name (post) * - name to delete;</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Key and certificate have been successfully deleted for user: <name>';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'The required certificate cannot be removed because it is in use';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'No such key and certificate. There is nothing to delete ';</div> <div data-placeholder="Перевод" dir="ltr">error: 5, mess: 'Error in the parameter block';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.</div>
−
 
 
−
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;" |  
 
| style="vertical-align: top;" |  
Line 85: Line 43:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Создание ключа и сертификата.
+
Create key and certificate.
  
 
addcerts
 
addcerts
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">addcerts (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">key_size (post) - key size (by default 2048; can be 4096);</div> <div data-placeholder="Перевод" dir="ltr">domain (post) * - domain for which the certificate is applied;</div> <div data-placeholder="Перевод" dir="ltr">country (post) * - country (defined by two characters; default 'ru');</div> <div data-placeholder="Перевод" dir="ltr">state (post) * - state (string variable);</div> <div data-placeholder="Перевод" dir="ltr">city ​​(post) * - city (string variable);</div> <div data-placeholder="Перевод" dir="ltr">company (post) * - company (string variable);</div> <div data-placeholder="Перевод" dir="ltr">division (post) * - department (string variable);</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (by default ru);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New certificate has been successfully added for user: <name>', data: contains the name of the new key and certificate;</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while adding a new certificate for the user: <name>';</div> <div data-placeholder="Перевод" dir="ltr">error: 5, mess: 'Error in the parameter block';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.</div>
−
 
 
−
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;" |  
 
| style="vertical-align: top;" |  
Line 132: Line 54:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Добавление ключа и сертификата к домену.
+
Add key and certificate for domain.
  
 
savedomaincerts
 
savedomaincerts
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">savedomaincerts (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">domain (post) * - domain for which the certificate is applied;</div> <div data-placeholder="Перевод" dir="ltr">key (post) * - the key that applies to the domain. Or specify the 'letencrypt' option to generate a key of this type;</div> <div data-placeholder="Перевод" dir="ltr">key_mail (post) - apply the key for mail: yes / no (by default - no).</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The certificate was installed for the domain: <domain>';</div> <div data-placeholder="Перевод" dir="ltr">error: 5, mess: 'Error in the parameter block';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.</div>
−
 
 
−
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;" |  
 
| style="vertical-align: top;" |  
Line 165: Line 65:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Получить список доменов с сертификатами.
+
Get list of domains with certificates.
−
 
 
−
| 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;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">listdomaincerts (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div>
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'A list of domains using certificates was received for the user: <name>', data: contains a list of domains;</div> <div data-placeholder="Перевод" dir="ltr">error: 5, mess: 'Error in the parameter block';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.</div>
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 194: Line 74:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Удалить сертификат с домена.
+
delete certificate from domain.
  
 
deldomaincerts
 
deldomaincerts
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">deldomaincerts (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">domain (post) * - domain for which the certificate is being deleted;</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The certificate was removed from the domain';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error, such domain was not found or does not contain any certificate';</div> <div data-placeholder="Перевод" dir="ltr">error: 5, mess: 'Error in the parameter block';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.</div>
−
 
 
−
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>'.
 
−
 
 
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
 
{| style="width: 1191px;"
 
{| style="width: 1191px;"

Revision as of 01:17, 11 April 2021

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

certs_control

Show user certificates.

listcerts

username (post) * - username;
password (post) * - user password;
certs_control (post) * - constant, module name;
listcerts (post) * - constant, operation type;
language (post) - can take the value: en / ru (ru by default);
panel_user (post) - ISP username to which the operation is applied.

error: 0, mess: 'The list of certificates was successfully received for the user: <name>', data: contains the list of certificates;

error: 1, mess: 'There was an error getting the list of certificates for the user: <name>';

error: 5, mess: 'Error in the parameter block';

error: 1000, mess: 'You do not have administrator rights';

error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.

certs_control

Delete certificate and key.

delcerts

username (post) * - username;
password (post) * - user password;
certs_control (post) * - constant, module name;
delcerts (post) * - constant, type of operation;
key_name (post) * - name to delete;
language (post) - can take the value: en / ru (ru by default);
panel_user (post) - ISP username to which the operation is applied.
error: 0, mess: 'Key and certificate have been successfully deleted for user: <name>';
error: 1, mess: 'The required certificate cannot be removed because it is in use';
error: 2, mess: 'No such key and certificate. There is nothing to delete ';
error: 5, mess: 'Error in the parameter block';
error: 1000, mess: 'You do not have administrator rights';
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.

certs_control

Create key and certificate.

addcerts

username (post) * - username;
password (post) * - user password;
certs_control (post) * - constant, module name;
addcerts (post) * - constant, type of operation;
key_size (post) - key size (by default 2048; can be 4096);
domain (post) * - domain for which the certificate is applied;
country (post) * - country (defined by two characters; default 'ru');
state (post) * - state (string variable);
city ​​(post) * - city (string variable);
company (post) * - company (string variable);
division (post) * - department (string variable);
language (post) - can take the value: en / ru (by default ru);
panel_user (post) - ISP username to which the operation is applied.
error: 0, mess: 'New certificate has been successfully added for user: <name>', data: contains the name of the new key and certificate;
error: 1, mess: 'An error occurred while adding a new certificate for the user: <name>';
error: 5, mess: 'Error in the parameter block';
error: 1000, mess: 'You do not have administrator rights';
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.

certs_control

Add key and certificate for domain.

savedomaincerts

username (post) * - username;
password (post) * - user password;
certs_control (post) * - constant, module name;
savedomaincerts (post) * - constant, type of operation;
domain (post) * - domain for which the certificate is applied;
key (post) * - the key that applies to the domain. Or specify the 'letencrypt' option to generate a key of this type;
key_mail (post) - apply the key for mail: yes / no (by default - no).
error: 0, mess: 'The certificate was installed for the domain: <domain>';
error: 5, mess: 'Error in the parameter block';
error: 1000, mess: 'You do not have administrator rights';
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.

certs_control

Get list of domains with certificates.

username (post) * - username;
password (post) * - user password;
certs_control (post) * - constant, module name;
listdomaincerts (post) * - constant, type of operation;
language (post) - can take the value: en / ru (ru by default);
panel_user (post) - ISP username to which the operation is applied.
error: 0, mess: 'A list of domains using certificates was received for the user: <name>', data: contains a list of domains;
error: 5, mess: 'Error in the parameter block';
error: 1000, mess: 'You do not have administrator rights';
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.

certs_control

delete certificate from domain.

deldomaincerts

username (post) * - username;
password (post) * - user password;
certs_control (post) * - constant, module name;
deldomaincerts (post) * - constant, type of operation;
domain (post) * - domain for which the certificate is being deleted;
language (post) - can take the value: en / ru (ru by default);
panel_user (post) - ISP username to which the operation is applied.
error: 0, mess: 'The certificate was removed from the domain';
error: 1, mess: 'Error, such domain was not found or does not contain any certificate';
error: 5, mess: 'Error in the parameter block';
error: 1000, mess: 'You do not have administrator rights';
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.

Other useful articles:

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:_User_Certificates&oldid=1356"