cPanel API 2 Functions - SSH::converttoppk

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function converts an SSH key to PuTTY's PPK file format. This function returns the private key and associated passphrase package, ready to use with PuTTY.

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=converttoppk&name=user&pass=12345luggage&keep_file=1

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.

// List all SSH keys
$convert_key = $cpanel->api2(
    'SSH', 'converttoppk',
  array(
        'name' => 'user',
        'pass' => '12345luggage',
        'keep_file' => '1'
   )
);

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.

# Convert "user" key to PPK
my $convert_key = $cpliveapi->api2(
    'SSH', 'converttoppk'
   {
        'name' => 'user',
        'pass' => '12345luggage',
        'keep_file' => '1'
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username SSH converttoppk name=user pass=12345luggage keep_file=1

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "converttoppk",
    "data": [
      {
        "name": "user",
        "key": "PuTTY-User-Key-File-2: ssh-rsa\nEncryption: aes256-cbc\nComment: imported-openssh-key\nPublic-Lines: 4\nAAAAB3NzaC1yc2EAAAABIwAAAIEAyA\/gWr2PhASaqu9hlK+fl2uo6QFfZLROy9DT\nLPM06dmyE3w9Ix+yA7PmU7\/yqUcGZScLkg6fcrkPkWDZ1sci1F03WCz6AAwrcEVv\nqqFFVSST+RFbR5BlWdB7ja7Aob04ZdpQy8N2NG4C5zMJ1yMf5gR84PaCmlGD3t9B\nEFdN4rk=\nPrivate-Lines: 8\nWv1TuAVwEVQmLrB8PWErTSYkhrtJn+9EIEpQ++VOjQJ+23C7pwdtx9h+le67wkQt\nDFOkt0K5EMEvtdwQs6v7X5CrRGJ2hdhGtvtledCfmEXOf8RYAI\/idHP18MTczILX\nAbcC\/AGdwBFFytonLyYnmyVkCbVq40HShutR29W\/cg8kqklxS2uuOr2yOjx81EVa\n6es5btP3ayvYDehz9Ey8s9ERSXvcj4p61KLqy2Tj7qzLjSPLTYAiV+fYawbEfm6n\ntMm6qAqHBDzGNxL\/xcP3K3HMtFyZTQg8ShoVv+t8meroxVNDBY5EnFRFbNqWGALT\n\/Dd0PjPk5VzAOyL2PR9t+3sC\/5eOqdIy5KSwVeZhg5LsBe4gnDf1zMmpwSMGDXoz\npFyG6hFwI1KkCBqsMTmZCcahLyXzG+Y1R2pPMQL1\/DE7sFxZ0Yc4aZhsjPDermod\n+Rr8AyskJW5Jp81e0sM2eA==\nPrivate-MAC: ada6730e6780e05fb2c69416791629ce71faa71b\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

Note:

If you do not specify any parameters, the function will return all of the account's keys.

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`name`	string	Required The SSH key's filename.	A valid string. You cannot use the following filenames: `config` `known_hosts` `authorized_keys` `environment` `rc` `identity`	`user`
`pass`	string	The SSH key's password.	A secure password.	`12345luggage`
`keep_file`	Boolean	Whether to retain the PPK file in the user's `.ssh` directory.	`1` — Store the file. `0` — Do not store the file.	`1`

name

string

Required

The SSH key's filename.

A valid string.

You cannot use the following filenames:

config
known_hosts
authorized_keys
environment
rc
identity

user

pass string The SSH key's password. A secure password. 12345luggage

keep_file

Boolean

Whether to retain the PPK file in the user's .ssh directory.

1 — Store the file.
0 — Do not store the file.

1

Returns

Return	Type	Description	Possible values	Example
`name`	string	The SSH key's name.	A valid filename.	`user`
`key`	string	The PPK file.	A string that contains the new PPK file.	PuTTY-User-Key-File-2: ssh-rsa\nEncryption: aes256-cbc\nComment: imported-openssh-key\nPublic-Lines: 4\nAAAAB3NzaC1yc2EAAAABIwAAAIEAyA\/gWr2PhASaqu9hlK+fl2uo6QFfZLROy9DT\nLPM06dmyE3w9Ix+yA7PmU7\/yqUcGZScLkg6fcrkPkWDZ1sci1F03WCz6AAwrcEVv\nqqFFVSST+RFbR5BlWdB7ja7Aob04ZdpQy8N2NG4C5zMJ1yMf5gR84PaCmlGD3t9B\nEFdN4rk=\nPrivate-Lines: 8\nWv1TuAVwEVQmLrB8PWErTSYkhrtJn+9EIEpQ++VOjQJ+23C7pwdtx9h+le67wkQt\nDFOkt0K5EMEvtdwQs6v7X5CrRGJ2hdhGtvtledCfmEXOf8RYAI\/idHP18MTczILX\nAbcC\/AGdwBFFytonLyYnmyVkCbVq40HShutR29W\/cg8kqklxS2uuOr2yOjx81EVa\n6es5btP3ayvYDehz9Ey8s9ERSXvcj4p61KLqy2Tj7qzLjSPLTYAiV+fYawbEfm6n\ntMm6qAqHBDzGNxL\/xcP3K3HMtFyZTQg8ShoVv+t8meroxVNDBY5EnFRFbNqWGALT\n\/Dd0PjPk5VzAOyL2PR9t+3sC\/5eOqdIy5KSwVeZhg5LsBe4gnDf1zMmpwSMGDXoz\npFyG6hFwI1KkCBqsMTmZCcahLyXzG+Y1R2pPMQL1\/DE7sFxZ0Yc4aZhsjPDermod\n+Rr8AyskJW5Jp81e0sM2eA==\nPrivate-MAC: ada6730e6780e05fb2c69416791629ce71faa71b\n
`result`	string	The SSH key's status.	`1` — Success. `0` — Failure.	`1`
`reason`	string	A reason for failure. 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` — Success. `0` — Failure.	`1`