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

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

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

## Example requests and responses

## cURL

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

## 200 OK

```json
{
    "error": null,
    "data": {
        "filterObjects": [
            {
                "filterName": "status",
                "displayName": "Status",
                "values": [
                    "error",
                    "install_pending",
                    "not_configured",
                    "stopped",
                    "suspended",
                    "update_pending"
                ]
            }
        ]
    }
}
```

## 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>accountId</td>
<td>required</td>
<td></td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionIds</td>
<td>required</td>
<td>array</td>
<td>User's division IDs.</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>
<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>state</code>, <code>status</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>.. filterObjects</td>
<td>object</td>
<td>Object container for filter configuration details.</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>name</code></td>
<td>EQUALS</td>
<td><code>Sensor name</code></td>
</tr>
<tr>
<td><code>state</code></td>
<td>EQUALS</td>
<td><code>Enable</code>, <code>Inactive</code></td>
</tr>
<tr>
<td><code>status</code></td>
<td>EQUALS</td>
<td><code>suspended</code>, <code>not_configured</code>,<code>install_pending</code>, <code>error</code>,<code>stopped</code>, <code>updating</code>, <code>update_pending</code>, <code>pending</code>, <code>scanning</code>, <code>configured</code>.</td>
</tr>
</tbody>
</table>