---
title: "Get scan details"
source_url: https://dev.digicert.com/certcentral-apis/discovery-api/list-and-filter/get-scan-details.html
api_method: GET
api_endpoint: "/apicontroller/v1/scan/getScanDetails"
api_url: "https://daas.digicert.com/apicontroller/v1/scan/getScanDetails?surveyDefId=292888&accountId=5153184&divisionId=677793"
---

**GET** `https://daas.digicert.com/apicontroller/v1/scan/getScanDetails?surveyDefId=292888&accountId=5153184&divisionId=677793`

Use this endpoint to get information about an existing scan template.

## 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/getScanDetails?surveyDefId=292888&accountId=5153184&divisionId=677793' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw ''
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "accountId": "5153184",
        "divisionId": 677793,
        "surveyName": "02april2020 01",
        "frequencyType": "daily",
        "surveyDefId": 292888,
        "state": "active",
        "createdTime": 1585829323489,
        "startTime": 52200000,
        "hasVulnerability": true,
        "currentScanJobList": [{
			"startTime": 1628060456025,
			"percentageCompleted": 0.0,
			"state": 10,
			"vulStartTime": null,0
			"vulPercentageCompleted": 0.0,
			"vulState": null,
			"duration": null,
			"vulEnabled": true,
			"jobId": "368173",
			"includedSensors": [{a
				"ipInclusionList":  "www.yahoo.com,www.google.com,www.digicert.com",
				"includedPorts": ["443", "389", "636", "22", "143", "110", "465",  
                                          "8443", "3389"],
				"openPorts": null,
				"ipExclusionList": "",
				"licenseKey": "DBE32EF28E344F97",
				"includeAllSubdomains": ["www.digicert.com"],
				"selectedSubdomains": [{
					"domain": "www.yahoo.com",
					"subdomains": ["accountlink.www.yahoo.com", 
                                                  "secure.www.yahoo.com"]
				}, {
					"domain": "www.google.com",
					"subdomains": ["www.google.com----------------- 
                                                  r.reflectiz.com"]
				}],
				"ipv4Sensor": false,
				"portSelectionChoice": "default"
			}]
		}],
        "vulnerabilityScanOption": "critical",
        "surveyConfigDTO": {
            "sensorWithIpPortDTO": [
                {
                    "ipInclusionList": "www.yahoo.com,www.google.com,www.digicert.com",
                    "includedPorts": ["443", "389", "636", "22", "143", "110", "465", "8443", "3389"],
                    "openPorts": null,
                    "ipExclusionList": "",
                    "licenseKey": "DBE32EF28E344F97",
                    "includeAllSubdomains": ["www.digicert.com"],
                    "selectedSubdomains": [{
					"domain": "www.yahoo.com",
					"subdomains": ["accountlink.www.yahoo.com", 
                                                   "secure.www.yahoo.com"]
		  }, {
					"domain": "www.google.com",
					"subdomains": ["www.google.com-----------------
                                                   r.reflectiz.com"]
		  }],
                    "ipv4Sensor": false,
                    "portSelectionChoice": "default"
                }
            ],
            "startTime": 0,
            "daysToRun": [],
            "disablePing": false,
            "timezone": "5:30#chennai",
            "timeToComplete": 0,
            "vulnerabilityList": "Heartbleed,POODLE (SSLv3),FREAK,LogJam,DROWN,RC4,POODLE (TLS)",
            "emulationScans": false,
            "sni": false,
            "tls13": false,
            "ipv6": false,
            "extraTlsProtocolsDiscovery": false,
            "sshDiscovery": true,
            "osDiscoverable": false,
            "serviceDiscoverable": false,
            "monthlyRecurrenceType": "1st",
            "speed": "medium",
            "refreshHPSInventory": "always",
            "scanOption": "custom"
        },
        "isCipherScan": false,
        "emailAddresses": "cc.admin@cert-testing.com",
        "listFilteredPorts": false,
        "tags": null
    }
}
```

## URL query 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>surveyDefId</td>
<td>required</td>
<td>integer</td>
<td>Survey definition ID of the scan. To get a list of <code>surveyDefId</code> values for your scans, use the <a href="https://dev.digicert.com/md/certcentral-apis/discovery-api/list-and-filter/scan-list.md">scan list</a> endpoint.</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>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Includes the error code if any.</td>
<td></td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object container for response.</td>
<td></td>
</tr>
<tr>
<td>.. accountId</td>
<td>string</td>
<td>Account ID.</td>
<td></td>
</tr>
<tr>
<td>.. divisionId</td>
<td>integer</td>
<td>Division ID.</td>
<td></td>
</tr>
<tr>
<td>surveyName</td>
<td>string</td>
<td>Friendly name provided for the scan.<br><strong>Max length:</strong>80 characters.</td>
<td></td>
</tr>
<tr>
<td>frequencyType</td>
<td>string</td>
<td><strong>Allowed values:</strong> <code>One Time</code>, <code>Daily</code>, <code>Weekly</code>, <code>Monthly</code>, <code>Cloud</code></td>
<td></td>
</tr>
<tr>
<td>surveyDefId</td>
<td>integer</td>
<td>Survey definition ID of the scan. To get a list of <code>surveyDefId</code> values for your scans, use the <a href="https://dev.digicert.com/md/certcentral-apis/discovery-api/list-and-filter/scan-list.md">scan list</a> endpoint.</td>
<td></td>
</tr>
<tr>
<td>.. state</td>
<td>string</td>
<td>Status of the scan.<br><strong>Possible values:</strong> <code>ACTIVE</code>, <code>SUSPENDED</code>, <code>DELETED</code>, <code>INPROGRESS</code></td>
<td></td>
</tr>
<tr>
<td>.. createdTime</td>
<td>integer</td>
<td>Scan creation time.</td>
<td></td>
</tr>
<tr>
<td>.. startTime</td>
<td>integer</td>
<td>Start time for the scheduled scan.<br><strong>Format:</strong>epoch in millisecond.<br>Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.<br><strong>Example: <code>1596781119</code></strong><br><strong>Note:</strong> <code>startTime</code> value should be <code>0</code> when the <code>frequencytype</code> is <code>onetime</code></td>
<td></td>
</tr>
<tr>
<td>.. hasVulnerability</td>
<td>boolean</td>
<td>If <code>true</code>, vulnerability discovery is enabled for the scan.</td>
<td></td>
</tr>
<tr>
<td>.. currentScanJobList</td>
<td>object</td>
<td>Object container for in-progress scans</td>
<td></td>
</tr>
<tr>
<td>.. .. startTime</td>
<td>integer</td>
<td>Start time of the current scan.<br><strong>Format:</strong>epoch in millisecond.<br>Epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.<br><strong>Example: <code>1596781119</code></strong><br><strong>Note:</strong> <code>startTime</code> value should be <code>0</code> when the <code>frequencytype</code> is <code>onetime</code></td>
<td></td>
</tr>
<tr>
<td>.. .. percentageCompleted</td>
<td>integer</td>
<td>Scan percentage completed.</td>
<td></td>
</tr>
<tr>
<td>.. .. state</td>
<td>integer</td>
<td>State of the scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. vulStartTime</td>
<td>integer</td>
<td>Vulnerability discovery start time.<br><strong>Format</strong>: Timestamp in milliseconds.<br><strong>Example</strong>: <code>5:30#chennai</code></td>
<td></td>
</tr>
<tr>
<td>.. .. vulPercentageCompleted</td>
<td>integer</td>
<td>Vulnerability scan percentage completed.<br><strong>Possible values</strong>: 0-100%</td>
<td></td>
</tr>
<tr>
<td>.. .. vulState</td>
<td>integer</td>
<td>Status of the vulnerability.</td>
<td></td>
</tr>
<tr>
<td>.. .. duration</td>
<td>integer</td>
<td>Duration of the scan in seconds.</td>
<td></td>
</tr>
<tr>
<td>.. .. vulEnabled</td>
<td>integer</td>
<td>Whether vulnerability is enabled. If <code>true</code>, vulnerability is enabled. Otherwise <code>false</code>.</td>
<td></td>
</tr>
<tr>
<td>.. .. jobId</td>
<td>string</td>
<td>Scan job ID.</td>
<td></td>
</tr>
<tr>
<td>.. .. includedSensors</td>
<td>object</td>
<td>Object container containing IP/port configuration details for the currently running scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. ipInclusionList</td>
<td>string</td>
<td>IPs to include in the scan. Supported formats are individual IPs, IP range, CIDR, and FQDNs.<br><strong>Example for IP format:</strong> <code>104.20.67.46</code><br><strong>Example for FQDN format:</strong> <code>digicert.com</code><br><strong>Note:</strong>Loopback IP "127.0.0.1" is not allowed to scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. includedPorts</td>
<td>array</td>
<td>Ports to include in the scan. It can be individual ports or port range.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. openPorts</td>
<td>array</td>
<td>A list of the open ports scanned. Used in scenarios where the host is unresponsive to ping.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. ipExclusionList</td>
<td>string</td>
<td>IPs to exclude in the scan. Supported formats are individual IPs, IP range, CIDR, and FQDNs.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. licenseKey</td>
<td>string</td>
<td>Sensor license key to create scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. includeAllSubdomains</td>
<td>array</td>
<td>List of domains to scan all subdomains for. If a domain is in this list, the scan includes all subdomains of that domain.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. selectedSubdomains</td>
<td>array</td>
<td>List of objects that define which subdomains of a given domain are included in the scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. domain</td>
<td>string</td>
<td>Name of the domain.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. subdomains</td>
<td>array</td>
<td>List of subdomains included in the scan for the given domain.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. isIPv4Sensor</td>
<td>boolean</td>
<td>Use <code>true</code> if the operating system of the installed sensor runs on IPv4.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. portSelectionChoice</td>
<td>string</td>
<td>Select the default port or choose from All/custom ports.</td>
<td></td>
</tr>
<tr>
<td>.. vulnerabilityScanOption</td>
<td>string</td>
<td>Setting that defines which vulnerabilities to scan for.<br><strong>Allowed values:</strong> <code>all</code>, <code>critical</code>.</td>
<td></td>
</tr>
<tr>
<td>.. surveyConfigDTO</td>
<td>object</td>
<td>Object container for scan configuration details.</td>
<td></td>
</tr>
<tr>
<td>.. .. sensorWithIpPortDTO</td>
<td>object</td>
<td>Object container for IP/port configuration details.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. ipInclusionList</td>
<td>string</td>
<td>IPs to include in the scan. Supported formats are individual IPs, IP range, CIDR, and FQDNs.<br><strong>Example for IP format:</strong> <code>104.20.67.46</code><br><strong>Example for FQDN format:</strong> <code>digicert.com</code><br><strong>Note:</strong>Loopback IP "127.0.0.1" is not allowed to scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. includedPorts</td>
<td>string</td>
<td>Ports to include in the scan. It can be individual ports or port range.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. openPorts</td>
<td>array</td>
<td>A list of the open ports scanned. Used in scenarios where the host is unresponsive to ping.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. ipExclusionList</td>
<td>string</td>
<td>IPs to exclude in the scan. Supported formats are individual IPs, IP range, CIDR, and FQDNs.<br><strong>Example for IP format:</strong> <code>104.20.67.46</code><br><strong>Example for FQDN format:</strong> <code>digicert.com</code><br><strong>Note:</strong>Loopback IP "127.0.0.1" is not allowed to scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. licenseKey</td>
<td>string</td>
<td>Sensor license key to create scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. includeAllSubdomains</td>
<td>array</td>
<td>List of domains to scan all subdomains for. If a domain is in this list, the scan includes all subdomains of that domain.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. selectedSubdomains</td>
<td>array</td>
<td>List of objects that define which subdomains of a given domain are included in the scan.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. .. domain</td>
<td>string</td>
<td>Name of the domain.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. .. subdomains</td>
<td>array</td>
<td>List of subdomains included in the scan for the given domain.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. isIPv4Sensor</td>
<td>boolean</td>
<td>Use <code>true</code> if the operating system of the installed sensor runs on IPv4.</td>
<td></td>
</tr>
<tr>
<td>.. .. .. .. portSelectionChoice</td>
<td>string</td>
<td>Select the default port or choose from All/custom ports.</td>
<td></td>
</tr>
<tr>
<td>.. daysToRun</td>
<td>integer</td>
<td>Days when the scheduled scan runs.<br><strong>Possible values:</strong> <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, <code>5</code>, <code>6</code>,<code>7</code><br><strong>Note:</strong> <code>1</code> being Sunday.</td>
<td></td>
</tr>
<tr>
<td>.. disablePing</td>
<td>boolean</td>
<td>Enable hosts discovery that do not respond to ping.<br><strong>Note:</strong> : If <code>true</code>, <code>openPorts</code> should be provided.</td>
<td></td>
</tr>
<tr>
<td>.. timezone</td>
<td>string</td>
<td>Time zone for the scan.<br><strong>Format:</strong> GMT + your timezone offset.<br><strong>Example:</strong> <code>-8#pacifictime</code></td>
<td></td>
</tr>
<tr>
<td>.. timeToComplete</td>
<td>int</td>
<td>Wait time to complete the scan. <strong>0</strong> implies no timeout.</td>
<td></td>
</tr>
<tr>
<td>.. vulnerabilityList</td>
<td>string</td>
<td>This is a comma separated list of the vulnerabilities to scan for.<br><strong>Allowed values:</strong> <code>Heartbleed</code>, <code>POODLE(SSLv3)</code>, <code>FREAK</code>, <code>LogJam</code>, <code>DROWN</code>, <code>RC4</code>, <code>POODLE(TLS)</code>, <code>BEAST</code>, <code>CRIME</code>, <code>BREACH</code>, <code>SWEET32</code>.</td>
<td></td>
</tr>
<tr>
<td>.. emulationScans</td>
<td>boolean</td>
<td>If <code>true</code>, it will exclude <code>Heartbleed</code> and <code>POODLE (TLS)</code> from vulnerability discovery.</td>
<td></td>
</tr>
<tr>
<td>.. sni</td>
<td>boolean</td>
<td>Enable the Server Name Indication (SNI) for your scan.</td>
<td></td>
</tr>
<tr>
<td>.. tls13</td>
<td>boolean</td>
<td>Enable scan of TLS v1.3 protocol.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>.. ipv6</td>
<td>boolean</td>
<td>Use true if IPv6 addresses are used.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>.. extraTlsProtocolsDiscovery</td>
<td>boolean</td>
<td>Enable discovery of extra TLS protocol.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>.. sshDiscovery</td>
<td>boolean</td>
<td>Enable SSH key to be discovered.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>.. osDiscoverable</td>
<td>boolean</td>
<td>Include or exclude OS information.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>.. serviceDiscoverable</td>
<td>boolean</td>
<td>Include or exclude server application information.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>.. monthlyRecurrenceType</td>
<td>string</td>
<td>Day of the month specified for recurring scan.<br><strong>Allowed values:</strong> <code>1st</code>, <code>2nd</code>, <code>3rd</code>, <code>4th</code>, <code>5th</code><br><strong>Note:</strong> <code>1st</code> being the first day of the month.</td>
<td></td>
</tr>
<tr>
<td>.. speed</td>
<td>string</td>
<td>How fast the scan completes.<br><strong>Default:</strong> <code>medium</code><br><strong>Allowed values:</strong> <code>slow</code>, <code>medium</code>, <code>fast</code></td>
<td></td>
</tr>
<tr>
<td>.. refreshHPSInventory</td>
<td>string</td>
<td>How often the host inventory will refresh. <code>1</code> – always, <code>2</code> –monthly, <code>0</code> – never</td>
<td></td>
</tr>
<tr>
<td>.. scanOption</td>
<td>string</td>
<td>Configure the scan settings either to <code>custom</code> / <code>optimize</code>.</td>
<td></td>
</tr>
<tr>
<td>isCipherScan</td>
<td>boolean</td>
<td>Enable scan for ciphers configured on server.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>emailAddress</td>
<td>string</td>
<td>Email address for the contact associated with the scan.</td>
<td></td>
</tr>
<tr>
<td>listFilteredPorts</td>
<td>boolean</td>
<td>If enabled, scan will list all the closed and filtered ports.<br><strong>Default:</strong> <code>false</code></td>
<td></td>
</tr>
<tr>
<td>tags</td>
<td>string</td>
<td>Add tags to the scan. Tags can be a combination of letters (a-z or A-Z), numbers (0-9), number signs (#), or spaces. Entries must be comma-separated. (Maximum 512 characters).<br><strong>Note</strong>: Alphanumeric characters like #, @ and _ are allowed.</td>
<td></td>
</tr>
</tbody>
</table>