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

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

Use this endpoint to get the list of scan templates along with their name, status, and other information.

## 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 POST 'https://daas.digicert.com/apicontroller/v1/scan/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "searchCriteriaList": [],
    "divisionIds": [
        677793
    ],
    "isFromWallAlert": false,
    "sortOrder": "ASC"
}'
```

## 200 OK

```json
{
    "error": null,
    "data": [{
        "id": 2,
        "name": "Single cloud scan",
        "type": "Cloud",
        "frequency": "One Time",
        "state": "ACTIVE",
        "latestResult": "COMPLETED",
        "scheduled": "No",
        "divisionId": 677793
    }, {
        "id": 36,
        "name": "121box123",
        "type": "Agent",
        "frequency": "One Time",
        "state": "ACTIVE",
        "latestResult": "COMPLETED",
        "scheduled": "No",
        "divisionId": 677793
    }, {
        "id": 913,
        "name": "aaa",
        "type": "Agent",
        "frequency": "One Time",
        "state": "ACTIVE",
        "latestResult": "FAILED",
        "scheduled": "No",
        "divisionId": 677793
    }, {
        "id": 58,
        "name": "AgentscanRaghuagent",
        "type": "Agent",
        "frequency": "One Time",
        "state": "ACTIVE",
        "latestResult": "COMPLETED",
        "scheduled": "No",
        "divisionId": 677793
    }, {
        "id": 168,
        "name": "wins5onlyarchive",
        "type": "Agent",
        "frequency": "One Time",
        "state": "ACTIVE",
        "latestResult": "COMPLETED",
        "scheduled": "No",
        "divisionId": 677793
    }]
}
```

## 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. For definitions, see the Filter options for <a href="#filter-options-for-searchcriterialist">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>divisionId</td>
<td>required</td>
<td>array</td>
<td>Division IDs.</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>

## 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>.. id</td>
<td>integer</td>
<td>ID associated with the scan, also known as the  <code>surveyDefId</code></td>
</tr>
<tr>
<td>.. name</td>
<td>string</td>
<td>Friendly name the administrator gave to the CertCentral Discovery scan.</td>
</tr>
<tr>
<td>.. type</td>
<td>string</td>
<td>Source used to identify the scan.<br><strong>Allowed values:</strong> <code>Cloud</code>, <code>Agent</code>, <code>Sensor.</code></td>
</tr>
<tr>
<td>.. frequency</td>
<td>string</td>
<td>How often the scan will run.<br><strong>Allowed values:</strong> <code>One Time</code>, <code>Daily</code>, <code>Weekly</code>,<code>Monthly.</code></td>
</tr>
<tr>
<td>.. state</td>
<td>string</td>
<td>State of the scan.<br><strong>Allowed values:</strong> <code>ACTIVE</code>, <code>SUSPENDED</code>, <code>DELETED</code>,<code>INPROGRESS.</code></td>
</tr>
<tr>
<td>.. latestResult</td>
<td>string</td>
<td>Result of latest scan run.<br><strong>Allowed values:</strong> <code>COMPLETED</code>, <code>FAILED</code>, <code>PARTIAL</code>,<code>SKIPPED.</code></td>
</tr>
<tr>
<td>.. scheduled</td>
<td>string</td>
<td>Scan time scheduled or not.<br><strong>Allowed values:</strong> <code>YES</code>, <code>NO</code></td>
</tr>
<tr>
<td>.. divisionId</td>
<td>integer</td>
<td>Division ID.</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>