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

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

Use this endpoint to get information about a sensor.

## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/sensor/getSensorDetails' \
--header 'X-DC-DEVKEY: {{api_key}}'' \
--header 'Content-Type: application/json' \
--data-raw '{"licenseKey":{{license_key}},"accountId":5153184,"divisionId":677793}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "accountId": "5153184",
        "divisionId": 677793,
        "licenseKey": "6DE804CF68C9CF06",
        "sensorName": "14maysensorproxy",
        "updatePreference": "0",
        "stateString": "Inactive",
        "statusString": "Error",
        "sensorVersion": "3.8.10",
        "updateAvailable": false,
        "publishUpgradeOption": false,
        "emailAddresses": 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>licenseKey</td>
<td>required</td>
<td>string</td>
<td>Sensor license key .</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>integer</td>
<td>Division ID.</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>.. accountId</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>.. divisionId</td>
<td>integer</td>
<td>Division ID.</td>
</tr>
<tr>
<td>.. licenseKey</td>
<td>string</td>
<td>Sensor license key.</td>
</tr>
<tr>
<td>.. sensorName</td>
<td>string</td>
<td>Name of the sensor.</td>
</tr>
<tr>
<td>.. updatePreference</td>
<td>string</td>
<td>Sensor upgrade preference.<br><code>0</code> Automatic upgrade.<br><code>1</code> Manual upgrade.<br>Manually upgrade the sensor from the CertCentral UI.</td>
</tr>
<tr>
<td>.. stateString</td>
<td>string</td>
<td>Sensors state.<br><strong>Possible values:</strong> <code>Inactive</code>, <code>Enabled</code></td>
</tr>
<tr>
<td>.. statusString</td>
<td>string</td>
<td>Sensor status.<br><strong>Possible 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>Scanning</code>, <code>Configured</code>.</td>
</tr>
<tr>
<td>.. sensorVersion</td>
<td>string</td>
<td>Sensor version.</td>
</tr>
<tr>
<td>.. updateAvailable</td>
<td>boolean</td>
<td>Indicates whether a new sensor upgrade is available.<br><strong>Default:</strong> <code>false</code>.</td>
</tr>
<tr>
<td>.. publishUpgradeOption</td>
<td>boolean</td>
<td>If <code>updatePreference</code> is <code>1</code> and sensor upgrade is available, it will be <code>true</code>.</td>
</tr>
<tr>
<td>.. emailAddresses</td>
<td>string</td>
<td>Comma- separated list of email addresses for the contacts associated with the sensor.</td>
</tr>
</tbody>
</table>