Difference between revisions of "API: Certificates of services"
From BrainyCP
(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> | |
− | |||
− | |||
− | |||
− | |||
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Module'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Function'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <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 | + | | 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 | ||
− | |||
− | certs_control (post | ||
− | |||
− | show_sertificate (post | ||
− | |||
− | name_service (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, message:' | ||
− | |||
− | error:100, message:' | ||
− | |||
− | 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 | + | | 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 | ||
− | |||
− | certs_control (post | ||
− | |||
− | install_sertificate (post | ||
− | |||
− | name_service (post | ||
− | |||
− | cert (post)* | ||
− | |||
− | private_key (post)* | ||
− | |||
− | cabunle (post)* | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:1, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | 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 | + | | 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 | ||
− | |||
− | certs_control (post | ||
− | |||
− | delete_sertificate (post | ||
− | |||
− | name_service (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | 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 | + | | <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 | ||
− | |||
− | certs_control (post | ||
− | |||
− | generation_sertificate (post | ||
− | |||
− | language (post | ||
− | |||
− | | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1021px;" |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 298px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 325px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 376px;" | |
− | '''[https://docs.brainycp. | + | '''[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: