# cPanel API 2 Functions - SSH::listkeys Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function lists SSH keys. Warning: We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. ## Examples ### WHM API (JSON) ```undefined syntaxhighlighter-pre 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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. ### LiveAPI PHP Class ```undefined syntaxhighlighter-pre $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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). ### LiveAPI Perl Module ```undefined syntaxhighlighter-pre 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](/guides/guide-to-the-liveapi-system). ### cPanel Tag System (deprecated) Warnings: - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system). - 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation. ### Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username SSH listkeys ``` div 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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` ### Output (JSON) ```undefined syntaxhighlighter-pre { "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters table colgroup col col col col col thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code keys td em string td p The SSH key's filename. td p A valid string. p You strong cannot use the following names: ul li code config li code known_hosts li code authorized_keys li code environment li code rc li code identity td code user tr td code pub td em Boolean td p Whether to retrieve public or private keys. p If you do not use this parameter, the function returns keys of both types. td ul li code 1 — Public. li code 0 — Private. td code 0 tr td code types td em string td p The authorization type. p If you do not use this parameter, the function returns keys of both types. td ul li code rsa — Filter for code rsa encryption. li code dsa — Filter for code dsa encryption. td code rsa ## Returns table colgroup col col col col col thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code ctime td em integer td The key's creation time. td A datestamp in Unix time format. td code 1413917052 tr td code mtime td em integer td The key's last modification time. td A datestamp in Unix time format. td code 1413917052 tr td code file td em string td The full file path to the key. td A valid file path. td code zuul tr td code name td em string td The SSH key's name. td A valid filename. td code zuul tr td code haspub td em Boolean td Whether the private key has a matching public key. td ul li code 1 — Matching public key. li code 0 — No matching public key. td code 1 tr td code key td em string td p The SSH key's filename. td A string that contains the fingerprint and file location. td code user.pub tr td code auth td em Boolean td Whether the key is authorized. td ul li code 1 — Authorized. li code 0 — Unauthorized. td code 0 tr td code authaction td em Boolean td The key's authentication actions. td ul li code null — No options available. td code null tr td code authstatus td em Boolean td The key's authorization status. td ul li code 1 — Authorized. li code 0 — Unauthorized. td code 0 tr td code status td em string td The SSH key's status. td ul li code authorized li code deauthorized td code authorized tr td code reason td em string td p A reason for failure. This function only returns a code reason value if it failed. td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1