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

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

Use this endpoint to get a list of SSH key filters based on the selected filter criteria. This endpoint Is helpful when you wish to filter out the keys based on filter criteria available. While the Key list endpoint helps you get the entire list of keys available, the key filter endpoint allows you to narrow down the list of keys based on selected filter criteria available.

## Example requests and responses

## cURL

```bash
curl --location --request POST ' https://daas.digicert.com/apicontroller/v1/key/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"accountId": 5153289,
	"searchCriteriaList": [],
	"divisionIds": [],
	"startIndex": 1,
	"pageSize": 50,
	"filterSelected": "authenticationMethods",
	"sortedColumnId": "ip",
	"sortOrder": "ASC"
}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
		"filterName": "authenticationMethods",
		"displayName": "Authentication method",
		"values": ["gssapi-keyex", "gssapi-with-mic", "hostbased", "keyboard-interactive", "password", "publickey", "unavailable"]
	}
}
```

## 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;duplicateKeys&quot;,
    &quot;operation&quot;:&quot;EQUALS&quot;,
    &quot;value&quot;:[&quot;Yes&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>.</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>isCertPresent</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>.. filterName</td>
<td>string</td>
<td>Specified filter <code>key</code>.</td>
</tr>
<tr>
<td>.. displayName</td>
<td>string</td>
<td>Friendly name of the filter key as it appears in the UI.</td>
</tr>
<tr>
<td>.. values</td>
<td>array</td>
<td>List of sensors that meet the search criteria. The value shown for each sensor is the value set for the <code>filterSelected</code> parameter in the request body.</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>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>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>