Difference between revisions of "API: Certificates of services"
From BrainyCP
m (Protected "API: Certificates of services" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|
(No difference)
|
Revision as of 13:06, 26 July 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: