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

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

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

## Example requests and responses

## cURL

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

## 200 OK

```json
{
    "error": null,
    "data": [
        {
            "id": 59422,
            "licenseKey": "298361FD0316F91F",
            "name": "382desk_1",
            "sensorVersion": "3.8.2",
            "status": "stopped",
            "state": "inactive",
            "hostAddress": "172.18.160.70,172.17.158.97",
            "heartBeatPort": 8080,
            "commPort": 8443,
            "divisionId": 677815,
            "publishUpgradeOption": false,
            "sensorFeatures": {
                "cipherScan": true,
                "isTls13": true
            }
        },
        {
            "id": 59451,
            "licenseKey": "64CFD9CC228ACE2B",
            "name": "384Desk1",
            "sensorVersion": "3.8.4",
            "status": "error",
            "state": "inactive",
            "hostAddress": "172.18.160.70,172.17.122.161",
            "heartBeatPort": 8080,
            "commPort": 8443,
            "divisionId": 677815,
            "publishUpgradeOption": false,
            "sensorFeatures": {
                "cipherScan": true,
                "isTls13": true
            }
        },
        {
            "id": 59465,
            "licenseKey": "1B0EE18DE461033C",
            "name": "adddivdisable",
            "sensorVersion": "3.8.4",
            "status": "stopped",
            "state": "inactive",
            "hostAddress": "172.18.160.70,172.17.184.1",
            "heartBeatPort": 8080,
            "commPort": 8443,
            "divisionId": 677815,
            "publishUpgradeOption": false,
            "sensorFeatures": {
                "cipherScan": true,
                "isTls13": true
            }
        }
    ]
}
```

## Request parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Reqd/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="#section-idm4542014338848032886948319986">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>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionIds</td>
<td>required</td>
<td>array</td>
<td>User's division ID.</td>
</tr>
<tr>
<td>sortedColumnId</td>
<td></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>ASC</code> (ascending: 0-9, A-Z), <code>DESC</code> (descending: 9-0, Z-A)<br><strong>Default:</strong> <code>ASC</code></td>
</tr>
</tbody>
</table>

## Request 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 details about the sensors that meet the search criteria.</td>
</tr>
<tr>
<td>.. id</td>
<td>integer</td>
<td>Sensor ID.</td>
</tr>
<tr>
<td>.. licenseKey</td>
<td>string</td>
<td>License key for the sensor that is used to create a scan.</td>
</tr>
<tr>
<td>.. name</td>
<td>string</td>
<td>Friendly name for the sensor.</td>
</tr>
<tr>
<td>.. sensorVersion</td>
<td>string</td>
<td>Sensor version.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>Status of the scan.<br><strong>Allowed values:</strong> <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>
<tr>
<td>.. state</td>
<td>string</td>
<td>State of the sensor.<br><strong>Allowed values:</strong> <code>inactive</code>, <code>enabled</code></td>
</tr>
<tr>
<td>.. hostAddress</td>
<td>string</td>
<td>Comma-separated list of host addresses associated with the sensor.</td>
</tr>
<tr>
<td>.. heartBeatPort</td>
<td>integer</td>
<td>At this port, sensor will start the proxy server for agents. .</td>
</tr>
<tr>
<td>.. commPort</td>
<td>integer</td>
<td>SSL port for data communication from agent to sensor.</td>
</tr>
<tr>
<td>.. divisionId</td>
<td>integer</td>
<td>Division ID.</td>
</tr>
<tr>
<td>.. publishUpgradeOption</td>
<td>boolean</td>
<td>If <code>true</code> sensor upgrade is available.</td>
</tr>
<tr>
<td>.. sensorFeatures</td>
<td>object</td>
<td>Details about the sensor features that are enabled.</td>
</tr>
<tr>
<td>.. .. cipherScan</td>
<td>boolean</td>
<td>Whether scanning for ciphers that are configured on the server is enabled.<br><strong>Default:</strong> <code>false</code></td>
</tr>
<tr>
<td>.. .. isTls13</td>
<td>boolean</td>
<td>Whether scanning of TLS v1.3 protocol is enabled.<br><strong>Default:</strong> <code>false</code></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>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>