Difference between revisions of "API: User Certificates"

From BrainyCP
Jump to: navigation, search
m (Protected "API: User Certificates" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Line 84: Line 84:
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 925px;"
 
|-
 
|-
−
|  
+
| style="width: 271px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[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 API: автоустановщик CMS]'''
+
'''[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:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[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:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[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:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 271px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[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:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[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:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 332px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 271px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[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 API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 271px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 300px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[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-сервер API: FTP-сервер]'''
+
'''[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-адресов API: менеджер IP-адресов]'''
+
'''[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:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[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 API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Revision as of 11:56, 17 November 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: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist

Retrieved from "https://docs.brainycp.io/index.php?title=API:_User_Certificates&oldid=1878"