Description

This function lists SSH keys.

Examples 


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

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List all SSH keys
$list_key = $cpanel->api2(
    'SSH', 'listkeys'
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List all SSH keys
my $list_key = $cpliveapi->api2(
    'SSH', 'listkeys'
);

 

cpapi2 --user=username SSH listkeys

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
keysstring

The SSH key's filename.

A valid string.

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.

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