View source for API: User Certificates

<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> 
{| border="1" cellpadding="5"
|-
| <p dir="ltr" style="text-align: center;">'''Module'''</p> 
| <p dir="ltr" style="text-align: center;">'''Function'''</p> 
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> 
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p> 
|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Show user certificates.

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;" | 
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>'.

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

| style="vertical-align: top;" | 
Delete certificate and key.

delcerts

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Create key and certificate.

addcerts

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Add key and certificate for domain.

savedomaincerts

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
certs_control

| style="vertical-align: top;" | 
Get list of domains with certificates.

| 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;" | 
certs_control

| style="vertical-align: top;" | 
delete certificate from domain.

deldomaincerts

| 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> 
| 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> 
|}

Other useful articles:

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

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера <font><font>API: web server status</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами <font><font>API: transfer between servers</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером <font><font>API: web server management</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера <font><font>API: web server installation</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер <font><font>API: FTP server</font></font>]'''

|-
| style="width: 271px;" | 
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]'''

| style="width: 300px;" | 
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]'''

| style="width: 332px;" | 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''

|}