Function: sslkey
Result: the list of elements
SSL-keys
Access level: user
- server — Panel URL
- user — User
- cert — Certificate
- start — Creation date
- expire — Expiry date
- props — Properties
You can download the key. This operation can be run only once. The key file will be deleted upon downlaod
Function: sslkey.download
You can download the key. This operation can be run only once. The key file will be deleted upon downlaod
Access level: user
New SSL key
Function: sslkey.edit
Access level: user
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (key element of sslkey function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of sslkey function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- server — Panel URL. Different panel's addresses can use different SSL certificates for authentication. A new key will be valid only for the certificate used on this port
- self — . (Optional parameter. To enable the option click "on".) You can create a key for the current user or for any of his users
- username — Username. Enter the user for whom you want to generate a key. You must be the owner of that user
- type — Action. You can generate a new key, use the existing one, use the current key (if you used the key that is not registered in the system) or get a signed certificate to generate the key manually
- name — Key name. Enter a name for the certificate that will be shown in the system
- period — Validity period (days). A new key will be valid during the specified period starting today
- passwd — . Enter a password for the SSL key
- confirm — Re-enter password.
- subject — Key name. Enter the name of your key. Note: the key must be signed by the certificate specified in the HTTP server settings.
- request — SSL certificate request. You will get a signed certificate. To generate a key, convert it into PKCS#12 format. For example, you can use the command: openssl pkcs12 -export -in my.crt -inkey my.key -certfile ca.crt -out my.p12 -passout pass:your password
Delete
Function: sslkey.delete
Delete
Access level: user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of sslkey function.
Result: successful operation or error message