Description
This function generates an SSH key. The new SSH key will appear in the user's .ssh directory.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SSH&cpanel_jsonapi_func=genkey&bits=1024&name=user&pass=12345luggage&type=rsa
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_keys = $cpanel->api2(
'SSH', 'genkey',
array(
'bits' => '1024',
'name' => 'user',
'pass' => '12345luggage',
'type' => 'rsa',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_keys = $cpliveapi->api2(
'SSH', 'genkey',
{
'bits' => '1024',
'name' => 'user',
'pass' => '12345luggage',
'type' => 'rsa',
}
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username SSH genkey bits=1024 name=user pass=12345luggage type=rsa
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "genkey",
"data": [
{
"reason": "Generating public/private rsa key pair.\nEnter passphrase (empty for no passphrase): \nEnter same passphrase again: \nYour identification has been saved in /home/example/.ssh/user.\nYour public key has been saved in /home/example/.ssh/user.pub.\nThe key fingerprint is:\n89:7b:05:97:f7:93:ef:66:95:48:d3:de:e1:0d:21:3f \nThe key's randomart image is:\n+--[ RSA 1024]----+\n| |\n| .. . |\n| . o .o.. |\n| . + . +E+ |\n| . S . . Oo=|\n| . . . *+|\n| . . o|\n| . .o|\n| o.|\n+-----------------+",
"result": 1
}
],
"event": {
"result": 1
},
"module": "SSH"
}
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
bits
|
string
|
Required
The SSH key's level of encryption.
|
A positive integer of 1024 or more.
|
1024
|
|
name
|
string
|
Required
The SSH key's filename.
|
A valid string.
Note:
You cannot use the following names:
- config
- known_hosts
- authorized_keys
- environment
- rc
- identity
|
user
|
|
pass
|
string
|
The SSH key's password.
|
A secure string of four characters or more.
|
12345luggage
|
|
type
|
string
|
The SSH key's encryption method for authentication.
This parameter defaults to rsa.
|
|
rsa
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
reason
|
string
|
The raw response from the function.
|
A string that contains the fingerprint and file location.
|
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reasonvalue if it failed.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
