Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function generates an SSH key. The new SSH key will appear in the user's .ssh directory.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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

Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Generate an SSH key for "user"
$list_keys = $cpanel->api2(
    'SSH', 'genkey', 
    array(
        'bits' => '1024',
        'name' => 'user',
        'pass' => '12345luggage',
        'type' => 'rsa',
 ) 
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Generate an SSH key for "user"
my $list_keys = $cpliveapi->api2(
    'SSH', 'genkey',
    { 
        'bits' => '1024',
        'name' => 'user',
        'pass' => '12345luggage',
        'type' => 'rsa',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI 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 our Deprecated 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

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 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"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
bitsstring

Required

The SSH key's level of encryption.

 

A positive integer of 1024 or more.

1024
namestring

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
passstringThe SSH key's password.A secure string of four characters or more.12345luggage
typestring

The SSH key's encryption method for authentication.

This parameter defaults to rsa.

  • dsa
  • rsa
rsa

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstringThe raw response from the function.A string that contains the fingerprint and file location.
 Click to view...
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+-----------------+"
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1