---
title: "Filter scan"
source_url: https://dev.digicert.com/certcentral-apis/discovery-api/list-and-filter/filter-scan.html
api_method: POST
api_endpoint: "/apicontroller/v1/scan/filter"
api_url: "https://daas.digicert.com/apicontroller/v1/scan/filter"
---

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

Use this endpoint to get the list of the scans based on the filter criteria selected.

## Related topic

For more information on discovery scan and its details, see <a href="https://docs.digicert.com/en/certcentral/certificate-tools/discovery-user-guide/set-up-and-run-a-scan.html" target="_blank" rel="noopener noreferrer">Set up and run a scan</a>.

## Example requests and responses

## cURL

```bash
curl --location --request GET 'https://daas.digicert.com/apicontroller/v1/scan/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"searchCriteriaList":[],"filterSelected":"name","accountId":"5153184","divisionIds":[]}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "filterName": "name",
        "displayName": "name",
        "values": [
            "02april2020 01",
            "02Jul2019 01",
            "02Jul2019 01_1",
            "02Jul2019 03",
            "03Feb2020 01",
            "04may2020 01",
            "0507 tls",
            "05may2020 01",
            "06Feb2020 01",
            "06feb2020 03",
            "07feb2020 01",
            "vu18pi0b57ReinstateScan",
            "vur0p7pfsfVulScan",
            "vvf3bd61e4autoCreateScan",
            "vvggbvgghvautoCreateScan",
            "ジテンドラ..ヴァゲラ"
        ]
    }
}
```

## 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>searchCriteriaList</td>
<td>optional</td>
<td>array</td>
<td>Filter results by specified values. 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;state&quot;,
    &quot;operation&quot;:&quot;EQUALS&quot;,
    &quot;value&quot;:[&quot;ACTIVE&quot;]
  }
]</code></td>
</tr>
<tr>
<td>filterSelected</td>
<td>required</td>
<td>string</td>
<td>The value to show in the results for each scan that meets the search criteria.<br><strong>Allowed values:</strong> <code>name</code>, <code>sensor</code>, <code>state</code>, <code>latestResult</code>, <code>scantype</code>, <code>ipAddress</code>.</td>
</tr>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionId</td>
<td>required</td>
<td>array</td>
<td>Division IDs.</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 the error code if any.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object container for response.</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 scans that meet the search criteria. The value shown for each scan is the value set for the  <code>filterSelected</code> parameter in the request body.</td>
</tr>
</tbody>
</table>

## Filter options for searchCriteriaList

<table>
<thead>
<tr>
<th>Key</th>
<th>Operation</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code></td>
<td><code>EQUALS</code></td>
<td><code>Scan name</code></td>
</tr>
<tr>
<td><code>sensor</code></td>
<td><code>EQUALS</code></td>
<td><code>Sensor name</code></td>
</tr>
<tr>
<td><code>state</code></td>
<td><code>EQUALS</code></td>
<td><code>ACTIVE</code> ,<code>SUSPENDED</code>,<code>DELETED</code>, <code>INPROGRESS</code></td>
</tr>
<tr>
<td><code>latestResult</code></td>
<td><code>EQUALS</code></td>
<td><code>IN_PROGRESS</code>, <code>COMPLETED</code>, <code>FAILED</code>, <code>PARTIAL</code>, <code>IDLE</code>, <code>SKIPPED</code>, <code>CANCELLED</code></td>
</tr>
<tr>
<td><code>scantype</code></td>
<td><code>EQUALS</code></td>
<td><code>One Time</code>, <code>Daily</code>, <code>Weekly</code>, <code>Monthly</code></td>
</tr>
<tr>
<td><code>ipAddress</code></td>
<td><code>EQUALS</code></td>
<td><code>IP/FQDN</code></td>
</tr>
</tbody>
</table>