cPanel API 2 Functions - SSH::fetchkey - Knowledgebase

Description

This function retrieves an SSH key.

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=fetchkey&name=user&pub=0

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve the private SSH key for "user"
$list_key = $cpanel->api2(
    'SSH', 'fetchkey', 
    array(
        'name' => 'user',
        'pub' => '0',
 ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve the private SSH key for "user"
my $list_key = $cpliveapi->api2(
    'SSH', 'fetchkey',
    {
        'name' => '1024',
        'pub' => '0',
    }
);

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 fetchkey name=1024 pub=0

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "fetchkey",
    "data": [
      {
        "name": "user.pub",
        "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAomhpdCKB+gPO5TaxKWqvWa7dGsaSnKkrdRtb4S6DQQM2EcW2Xevp1HGYZr5YK3h2SGQqhkeFG44xv\/eJCIIai8FCHV3ulWlzzt4W6akTHWET1q6bl\/aUq36OvMdsBCiZ5UkhI0+ZAEpCQWdUpBQFHxaxZuypaJbL1ITmAs\/k+x8="
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SSH"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
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
pub	string	Whether to retrieve the public or private key. This value defaults to 0.	1 — Retrieve the public key. 0 — Retrieve the private key.	0

Parameter

Type

Description

Possible values

Example

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

pub

string

Whether to retrieve the public or private key.

This value defaults to 0.

1 — Retrieve the public key.
0 — Retrieve the private key.

Returns

Return	Type	Description	Possible values	Example
name	string	The SSH key's filename.	A string that contains the fingerprint and file location.	user
key	string	The SSH key.	A valid SSH key.
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

Knowledgebase

Categories

Categories