---
title: "Return SSH keys list"
method: GET
path: "/listsshkeys"
tags: ["SSH Keys and Connections"]
---

# Return SSH keys list

`GET /listsshkeys`

This function lists the server's SSH keys.

**Warning:**

Only the `root` account can use this function, and it only affects the `root`
keys. To perform this function on a regular user account, call the cPanel API
2 `SSH::listkeys` function through the WHM API.

## Query parameters

- `files` string
- `private` 0 | 1
- `private_texts` 0 | 1
- `public` 0 | 1
- `public_texts` 0 | 1
- `sync_authorized` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `keys` object[] — An array of objects of each key's information.
      - `authorized` 0 | 1 — Whether the key is authorized to access the server. * `1` — Authorized. * `0` — **Not** authorized.
      - `comment` string — The key's comment.
      - `ctime` integer — The date that the key was created, in [Unix time format](http://en.wikipedia.org/wiki/Unix_time).
      - `file` string — The key's filename.
      - `mtime` integer — The date that the key will expire, in Unix time format.
      - `private` 0 | 1 — Whether the private key is stored on the server. * `1` — The private key is on the server. * `0` — The private key is **not** on the server.
      - `text` string — The key's text.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)