Child pages
  • cPanel API 2 Functions - SSH::listkeys
Skip to end of metadata
Go to start of metadata

 

Description

This function lists SSH keys.


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=listkeys


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
$list_key = $cpanel->api2(
    'SSH', 'listkeys'
);


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.
 
# List all SSH keys
my $list_key = $cpliveapi->api2(
    'SSH', 'listkeys'
);


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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 listkeys


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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": "listkeys",
    "data": [
      {
        "ctime": 1413917058,
        "mtime": 1413917058,
        "file": "/home/example/.ssh/gozer",
        "name": "gozer",
        "haspub": 1,
        "key": "gozer",
        "auth": null,
        "authaction": 0,
        "authstatus": 0
      },
      {
        "ctime": 1413916230,
        "mtime": 1413916230,
        "file": "/home/example/.ssh/user",
        "name": "user",
        "haspub": 1,
        "key": "user",
        "auth": null,
        "authaction": 0,
        "authstatus": 0
      },
      {
        "ctime": 1413917052,
        "mtime": 1413917052,
        "file": "/home/example/.ssh/zuul",
        "name": "zuul",
        "haspub": 1,
        "key": "zuul",
        "auth": null,
        "authaction": 0,
        "authstatus": 0
      }
    ],
    "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
keysstring

The SSH key's filename.

A valid string.

Note:

You cannot use the following names:

  • config
  • known_hosts
  • authorized_keys
  • environment
  • rc
  • identity
user
pubBoolean

Whether to retrieve public or private keys.

If you do not use this parameter, the function returns keys of both types.

  • 1 — Public.
  • 0 — Private.
0
typesstring

The authorization type.

If you do not use this parameter, the function returns keys of both types.

  • rsa — Filter for rsa encryption.
  • dsa — Filter for dsa encryption.
rsa

Returns

ReturnTypeDescriptionPossible valuesExample
ctimeintegerThe key's creation time.A datestamp in Unix time format.
1413917052
mtimeintegerThe key's last modification time.A datestamp in Unix time format.
1413917052
filestringThe full file path to the key.A valid file path.zuul
namestringThe SSH key's name.A valid filename.zuul
haspubBooleanWhether the private key has a matching public key.
  • 1 — Matching public key.
  • 0 — No matching public key.
1
keystring

The SSH key's filename.

A string that contains the fingerprint and file location.user.pub
authBooleanWhether the key is authorized.
  • 1 — Authorized.
  • 0 — Unauthorized.
0
authactionBooleanThe key's authentication actions.
  • null — No options available.
null
authstatusBooleanThe key's authorization status.
  • 1 — Authorized.
  • 0 — Unauthorized.
0
statusstringThe SSH key's status.
  • authorized
  • deauthorized
authorized
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