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_legacy&bits=1024&name=user&pass=12345luggage&type=rsa
LiveAPI PHP Class
$cpanel = new CPANEL();
$gen_keys = $cpanel->api2(
'SSH', 'genkey_legacy',
array(
'bits' => '1024',
'name' => 'user',
'pass' => '12345luggage',
'type' => 'rsa',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $gen_keys = $cpliveapi->api2(
'SSH', 'genkey_legacy',
{
'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.
Output (JSON)
{Renaming existing key by same name to /home/example/.ssh/id_dsa.1415314678<br />
Generating public/private dsa key pair.<br />
Enter passphrase (empty for no passphrase): <br />
Enter same passphrase again: <br />
Your identification has been saved in /home/example/.ssh/id_dsa.<br />
Your public key has been saved in /home/example/.ssh/id_dsa.pub.<br />
The key fingerprint is:<br />
3f:0c:f4:9f:70:38:8b:55:78:1a:03:9e:fd:29:eb:00 <br />
The key's randomart image is:<br />
+--[ DSA 1024]----+<br />
| . |<br />
| . + . |<br />
| + = o |<br />
| . . O . |<br />
| E S O + |<br />
| . * O . |<br />
| o * o |<br />
| o . |<br />
| . |<br />
+-----------------+<br />
{
"cpanelresult": {
"apiversion": 2,
"func": "genkey_legacy",
"data": [
],
"event": {
"result": 1
},
"module": "SSH"
}
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
bits
|
string
|
The SSH key's level of encryption.
|
A positive integer of 1024 or more.
|
1024
|
|
name
|
string
|
The SSH key's filename.
|
A valid string.
Note:
The following names are reserved:
- 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.
|
Note:
This parameter defaults to rsa.
|
rsa
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reason value 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
|
