---
title: "List keys"
source_url: https://dev.digicert.com/certcentral-apis/discovery-api/keys/list-keys.html
api_method: POST
api_endpoint: "/apicontroller/v1/key/list"
api_url: "https://daas.digicert.com/apicontroller/v1/key/list"
---

**POST** `https://daas.digicert.com/apicontroller/v1/key/list`

Use this endpoint to get a list with details about your SSH keys.

## Related topic

For more information about SSH keys and how to discover SSH keys configured on your server, see <a href="https://docs.digicert.com/en/certcentral/certificate-tools/discovery-user-guide/ssh-keys.html" target="_blank" rel="noopener noreferrer">SSH keys</a>.

## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/key/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw 
'{
    "accountId": 5153184,
    "searchCriteriaList": [{
        "key": "keyName",
        "operation": "EQUALS",
        "value": ["f83d1b65a899a602c5c026beb32f21fd119b5976b34c16fb27496b5d68f3405a"]
    }, {
        "key": "keyIp",
        "operation": "EQUALS",
        "value": ""
    }, {
        "key": "keyPath",
        "operation": "EQUALS",
        "value": "C:\\Certbotold1\\archive\\17feb202001.cert-testing.com\\privkey10.pem"
    }],
    "divisionIds": [],
    "isDuplicateKeyList": true,
    "startIndex": 1,
    "pageSize": 50,
    "filterSelected": "keyName",
    "sortedColumnId": "ip",
    "sortOrder": "ASC"
}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "totalCount": 1,
        "currentCount": 1,
        "totalKeys": 0,
        "keyDetailsList": [{
            "keyName": null,
            "securityLevel": "Not secure",
            "ip": "",
            "port": null,
            "type": "RSA",
            "firstDiscovered": 1650259868203,
            "duplicateCount": null,
            "scanName": "",
            "protocol": null,
            "filePath": "C:\\Certbotold1\\keys\\0049_key-certbot.pem",
            "isRootKey": null,
            "isOrphanKey": null,
            "source": null,
            "serverHost": "Box64",
            "isProtectedKey": null
        }]
    }
}
```

## Request parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>searchCriteriaList</td>
<td>optional</td>
<td>array</td>
<td>Filter results by specified values. The array includes key, operation and value. For definitions, see the <a href="#filter-options-for-searchcriterialist">Filter options for searchCriteriaList</a> table below.<br><strong>Example:</strong><br><code>searchCriteriaList:[
  {
    &quot;key&quot;:&quot;userName&quot;,
    &quot;operation&quot;:&quot;EQUALS&quot;,
    &quot;value&quot;:[&quot;CertCentral Admin&quot;]
  }
]</code></td>
</tr>
<tr>
<td>divisionIds</td>
<td>required</td>
<td>array</td>
<td>User's division IDs.</td>
</tr>
<tr>
<td>startIndex</td>
<td>optional</td>
<td>integer</td>
<td>Index of the first result.<br><strong>Default</strong>: <code>1</code></td>
</tr>
<tr>
<td>pageSize</td>
<td>optional</td>
<td>integer</td>
<td>Number of records per page.<br><strong>Allowed values</strong>: <code>0</code> to <code>512</code><br><strong>Default</strong>: <code>50</code></td>
</tr>
<tr>
<td>filterSelected</td>
<td>required</td>
<td>string</td>
<td>The value to show in the results for each sensor that meets the search criteria.<br><strong>Allowed values:</strong> <code>name</code>, <code>ip</code>, <code>port</code>, <code>type</code>, <code>scanName</code>, <code>authenticationMethods</code>, <code>keyAlgorithm</code>, <code>protocol</code>, <code>duplicateKeys</code>,<code>userName</code>, <code>source</code>, <code>filePath</code>, <code>serverHost</code>, <code>orphanKeys</code></td>
</tr>
<tr>
<td>isDuplicateKeyList</td>
<td>required</td>
<td>boolean</td>
<td>Whether any duplicate key exist.<br><strong>Default</strong>: <code>true</code></td>
</tr>
<tr>
<td>sortedColumnId</td>
<td>optional</td>
<td>string</td>
<td>Sort results by specified parameter.<br><strong>Allowed values:</strong> <code>serialNumber</code>, <code>ip</code>, <code>port</code>, <code>scanName</code>, <code>serverSecurity</code>, <code>isCertPresent</code>, <code>cn</code><br><strong>Default:</strong> <code>ip</code></td>
</tr>
<tr>
<td>sortOrder</td>
<td>optional</td>
<td>string</td>
<td>Sort direction.<br><strong>Allowed values:</strong> <code>DESC</code> (descending: 9-0, Z-A), <code>ASC</code> (ascending: 0-9, A-Z)<br><strong>Default:</strong> <code>DESC</code></td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Includes error codes, if any.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object with information about the filter results.</td>
</tr>
<tr>
<td>.. totalCount</td>
<td>integer</td>
<td>Total number of keys based on the filter criteria.</td>
</tr>
<tr>
<td>.. currentCount</td>
<td>integer</td>
<td>Number of records on current page.</td>
</tr>
<tr>
<td>.. keydetailList</td>
<td>array</td>
<td>Container for key details.</td>
</tr>
<tr>
<td>.. .. keyName</td>
<td>string</td>
<td>Key name.<br><strong>Max length</strong>: 80 characters.</td>
</tr>
<tr>
<td>.. .. securityLevel</td>
<td>string</td>
<td>Security status of the key.<br><strong>Possible values</strong>: <code>Secure</code>, <code>Not secure</code></td>
</tr>
<tr>
<td>.. .. ip</td>
<td>string</td>
<td>IP address related to the key.</td>
</tr>
<tr>
<td>.. .. port</td>
<td>integer</td>
<td>Default SSH enabled port.</td>
</tr>
<tr>
<td>.. .. type</td>
<td>string</td>
<td>Type of the key.<br><strong>Possible values</strong>: <code>SSH</code></td>
</tr>
<tr>
<td>.. .. firstDiscovered</td>
<td>integer</td>
<td>Timestamp for when the key was first discovered.<br><strong>Format:</strong>epoch in millisecond.<br>Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.<br><strong>Example: <code>1596781119000</code></strong></td>
</tr>
<tr>
<td>.. .. duplicateCount</td>
<td>integer</td>
<td>Number of duplicates detected for the key.</td>
</tr>
<tr>
<td>.. .. scanName</td>
<td>string</td>
<td>Scan associated with the key.</td>
</tr>
<tr>
<td>.. .. protocol</td>
<td>string</td>
<td>Protocol used to set up an encrypted connection between the systems to communicate over the internet.<br><strong>Possible values</strong>: <code>SSH1</code>, <code>SSH2</code>.</td>
</tr>
<tr>
<td>.. .. filepath</td>
<td>string</td>
<td>The file path from where the key is discovered.</td>
</tr>
<tr>
<td>.. .. isRootKey</td>
<td>boolean</td>
<td>Whether it is a type of root key.</td>
</tr>
<tr>
<td>.. .. isOrphanKey</td>
<td>boolean</td>
<td>Whether it is an orphan key.<br>A key is orphaned when it cannot be used further because the pair is no longer on the server.</td>
</tr>
<tr>
<td>.. .. source</td>
<td>string</td>
<td>The source used to identify the key.<br><strong>Possible values</strong>: <code>Agent</code>, <code>Sensor</code>.</td>
</tr>
<tr>
<td>.. .. serverHost</td>
<td>string</td>
<td>The server host associated with the key.</td>
</tr>
<tr>
<td>.. .. isProtectedKey</td>
<td>boolean</td>
<td>Whether it is a protected key.</td>
</tr>
</tbody>
</table>

## Filter options for searchCriteriaList

The array includes key, operation and value.

<table>
<thead>
<tr>
<th>Key</th>
<th>Operation</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>userName</code></td>
<td>EQUALS</td>
<td><code>Cert Central Admin</code>, <code>system</code></td>
</tr>
<tr>
<td><code>keyName</code></td>
<td>EQUALS</td>
<td><code>Key name</code></td>
</tr>
<tr>
<td><code>ip</code></td>
<td>EQUALS</td>
<td><code>IP address</code></td>
</tr>
<tr>
<td><code>keyPath</code></td>
<td>EQUALS</td>
<td><code>Path to the key</code></td>
</tr>
<tr>
<td><code>port</code></td>
<td>EQUALS</td>
<td><code>22</code></td>
</tr>
<tr>
<td><code>authenticationMethods</code></td>
<td>EQUALS</td>
<td><code>gssapi-keyex</code>, <code>gssapi-with-mic</code>, <code>hostbased</code>., <code>keyboard-interactive</code>, <code>password</code>, <code>publickey</code>, <code>unavailable</code></td>
</tr>
<tr>
<td><code>duplicateKeys</code></td>
<td>EQUALS</td>
<td><code>No</code>, <code>Yes</code></td>
</tr>
<tr>
<td><code>type</code></td>
<td>EQUALS</td>
<td><code>SSH</code></td>
</tr>
<tr>
<td><code>rotationLimit</code></td>
<td>EQUALS</td>
<td><code>6 months</code>, <code>9 months1 year</code>, <code>2 years</code>.</td>
</tr>
<tr>
<td><code>keyAlgorithm</code></td>
<td>EQUALS</td>
<td><code>ECDSA SHA2 NISTP256 256</code>, <code>RSA1 1024</code>, <code>RSA1 2048</code>, <code>SSH DSS 1024</code>, <code>SSH RSA 1024</code>, <code>SSH ED25519 256</code>, <code>SSH RSA 2048</code>, <code>SSH RSA 3072</code>, <code>SSH RSA 4096</code>.</td>
</tr>
<tr>
<td><code>protocol</code></td>
<td>EQUALS</td>
<td><code>SSH1</code>, <code>SSH2</code></td>
</tr>
<tr>
<td><code>scanName</code></td>
<td>EQUALS</td>
<td><code>Scan name</code></td>
</tr>
</tbody>
</table>