Difference between revisions of "API: User Certificates"
From BrainyCP
| Line 87: | Line 87: | ||
|- | |- | ||
| style="width: 271px;" | | | style="width: 271px;" | | ||
| − | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
| style="width: 300px;" | | | style="width: 300px;" | | ||
Revision as of 12:42, 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:
