Difference between revisions of "API: Certificates of services"

From BrainyCP
Jump to: navigation, search
 
(5 intermediate revisions by 3 users not shown)
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 17: Line 13:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Вывод сертификатов сервиса.
+
Show service certificate.
  
 
show_sertificate
 
show_sertificate
  
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_sertificate (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">name_service (post or get) * - service name: 'smtp', 'ftp', 'brainy', 'imap', 'webserver';</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'Certificate found successfully', delail [array_sertificate];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, message: 'Service specified incorrectly', delail [name_services];</div> <div data-placeholder="Перевод" dir="ltr">error: 101, message: 'The certificate was not found or not installed';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'Unfortunately, the module is not available to you.'</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
certs_control (post или get)* — константа, имя модуля;
 
 
 
show_sertificate (post или get)* — константа, имя операции;
 
 
 
name_service (post или get)* — имя сервиса: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'smtp','ftp','brainy','imap','webserver';
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
| style="vertical-align: top;" |  
 
error:0, message:'Сертификат успешно найден', &nbsp;delail [array_sertificate];
 
 
 
error:100, message:'Неправильно указан сервис', &nbsp;delail [name_services];
 
 
 
error:101, message:'Сертификат не найден или не установлен';
 
 
 
error:400, message:'К сожалению, модуль вам не доступен'.
 
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 48: Line 24:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Установка сертификата сервиса.
+
Install service certificate.
  
 
install_sertificate
 
install_sertificate
  
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">install_sertificate (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">name_service (post or get) * - service name: 'smtp', 'ftp', 'brainy', 'imap', 'webserver';</div> <div data-placeholder="Перевод" dir="ltr">cert (post) * - certificate;</div> <div data-placeholder="Перевод" dir="ltr">private_key (post) * - private key;</div> <div data-placeholder="Перевод" dir="ltr">cabunle (post) *</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The new certificate was installed successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'MD5 check failed';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Invalid service specified.', delail [not_name_services];</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
certs_control (post или get)* — константа, имя модуля;
 
 
 
install_sertificate (post или get)* — константа, имя операции;
 
 
 
name_service (post или get)* — имя сервиса: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'smtp','ftp','brainy','imap','webserver';
 
 
 
cert (post)* — сертификат;
 
 
 
private_key (post)* — приватный ключ;
 
 
 
cabunle (post)*
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
| style="vertical-align: top;" |  
 
error:0, mess:'Новый сертификат установлен успешно';
 
 
 
error:1, mess:'Проверка MD5 не пройдена';
 
 
 
error:100, mess:'Неправильно указан сервис.', &nbsp;delail [not_name_services];
 
 
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 85: Line 35:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Удаление сертификата сервиса.
+
Delete service certificate.
  
 
delete_sertificate
 
delete_sertificate
  
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_sertificate (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">name_service (post or get) * - service name: 'smtp', 'ftp', 'brainy', 'imap', 'webserver';</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The certificate has been deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Service specified incorrectly.', delail [name_services];</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
certs_control (post или get)* — константа, имя модуля;
 
 
 
delete_sertificate (post или get)* — константа, имя операции;
 
 
 
name_service (post или get)* — имя сервиса: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'smtp','ftp','brainy','imap','webserver';
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
| style="vertical-align: top;" |  
 
error:0, mess:'Сертификат удален';
 
 
 
error:100, mess:'Не правильно указан сервис.', &nbsp;delail [name_services];
 
 
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 114: Line 46:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Генерирование сертификата.
+
Generate certificate.
  
 
generation_sertificate
 
generation_sertificate
  
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">certs_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">generation_sertificate (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
username (post или get)* — имя пользователя;
+
| <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New certificate and key generated.', detail [array_sertificate + key];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Error generating certificate';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately the module is not available to you'.</div>
 
 
password (post или get)* — пароль пользователя;
 
 
 
certs_control (post или get)* — константа, имя модуля;
 
 
 
generation_sertificate (post или get)* — константа, имя операции;
 
 
 
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
 
 
|  
 
error:0, mess:'Сгенерирован новый сертификат и ключ.', detail[array_sertificate + key];
 
 
 
error:100, mess:'Ошибка в генерации сертификата';
 
 
 
error:400, mess:'К сожалению модуль вам не доступен'.
 
 
 
 
|}
 
|}
  
Другие полезные статьи:
+
Other useful articles:
  
{| style="width: 1191px;"
+
{| style="width: 1021px;"
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 298px;" |  
'''[https://docs.brainycp.ru/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
|  
+
| style="width: 325px;" |  
'''[https://docs.brainycp.ru/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
|  
+
| style="width: 376px;" |  
'''[https://docs.brainycp.ru/index.php/API:_MySQL_processlist API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:32, 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 service certificate.

show_sertificate

username (post or get) * - username;
password (post or get) * - user password;
certs_control (post or get) * - constant, module name;
show_sertificate (post or get) * - constant, operation name;
name_service (post or get) * - service name: 'smtp', 'ftp', 'brainy', 'imap', 'webserver';
language (post or get) - can take the value: en / ru (ru by default).
error: 0, message: 'Certificate found successfully', delail [array_sertificate];
error: 100, message: 'Service specified incorrectly', delail [name_services];
error: 101, message: 'The certificate was not found or not installed';
error: 400, message: 'Unfortunately, the module is not available to you.'

certs_control

Install service certificate.

install_sertificate

username (post or get) * - username;
password (post or get) * - user password;
certs_control (post or get) * - constant, module name;
install_sertificate (post or get) * - constant, operation name;
name_service (post or get) * - service name: 'smtp', 'ftp', 'brainy', 'imap', 'webserver';
cert (post) * - certificate;
private_key (post) * - private key;
cabunle (post) *
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The new certificate was installed successfully';
error: 1, mess: 'MD5 check failed';
error: 100, mess: 'Invalid service specified.', delail [not_name_services];
error: 400, mess: 'Unfortunately, the module is not available to you.'

certs_control

Delete service certificate.

delete_sertificate

username (post or get) * - username;
password (post or get) * - user password;
certs_control (post or get) * - constant, module name;
delete_sertificate (post or get) * - constant, operation name;
name_service (post or get) * - service name: 'smtp', 'ftp', 'brainy', 'imap', 'webserver';
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The certificate has been deleted';
error: 100, mess: 'Service specified incorrectly.', delail [name_services];
error: 400, mess: 'Unfortunately, the module is not available to you.'

certs_control

Generate certificate.

generation_sertificate

username (post or get) * - username;
password (post or get) * - user password;
certs_control (post or get) * - constant, module name;
generation_sertificate (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'New certificate and key generated.', detail [array_sertificate + key];
error: 100, mess: 'Error generating certificate';
error: 400, mess: 'Unfortunately the module is not available to you'.

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