Use this endpoint to get information about an existing scan template.
For more information on discovery scan and its details, see Set up and run a scan
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 ''
{
"error": null,
"data": {
"accountId": "5153184",
"divisionId": 677793,
"surveyName": "02april2020 01",
"frequencyType": "daily",
"surveyDefId": 292888,
"state": "active",
"createdTime": 1585829323489,
"startTime": 52200000,
"hasVulnerability": true,
"currentScanJobList": [],
"vulnerabilityScanOption": "critical",
"surveyConfigDTO": {
"sensorWithIpPortDTO": [
{
"ipInclusionList": "google.com,digicert.com",
"includedPorts": [
"443"
],
"openPorts": null,
"ipExclusionList": "",
"licenseKey": "39AD64211B4956A8",
"portSelectionChoice": null
}
],
"startTime": 52200000,
"daysToRun": [],
"disablePing": false,
"timezone": "5:30#chennai",
"timeToComplete": 0,
"vulnerabilityList": "Heartbleed,POODLE (SSLv3),FREAK,LogJam,DROWN,RC4,POODLE (TLS)",
"emulationScans": false,
"sni": false,
"extraTlsProtocolsDiscovery": false,
"osDiscoverable": false,
"serviceDiscoverable": false,
"monthlyRecurrenceType": "1st",
"speed": "medium",
"refreshHPSInventory": "always",
"scanOption": "custom"
},
"isCipherScan": false,
"emailAddresses": "cc.admin@cert-testing.com"
}
}
Name | Req/Opt | Type | Description |
surveyDefId | required | integer |
Survey definition ID of the scan. To get a list of surveyDefId values for your scans, use the scan list endpoint.
|
accountId | required | string | Account ID. |
divisionId | required | integer | Division ID. |
Name | Type | Description |
---|---|---|
error | object | Includes the error code if any. |
data | object | Object container for response. |
.. accountId | string | Account ID. |
.. divisionId | integer | Division ID. |
surveyName | string |
Friendly name provided for the scan. Max length: 80 characters. |
frequencyType | string |
Allowed values: One Time , Daily , Weekly , Monthly , Cloud
|
surveyDefId | integer |
Survey definition ID of the scan. To get a list of surveyDefId values for your scans, use the scan list endpoint.
|
.. state | string |
Status of the scan. Possible values: ACTIVE , SUSPENDED , DELETED , INPROGRESS
|
.. createdTime | integer | Scan creation time. |
.. startTime | integer |
Start time for the scheduled scan. Format: epoch in millisecond. 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. Example: 1596781119 Note: startTime value should be 0 when the frequencytype is onetime
|
.. hasVulnerability | boolean |
If true , vulnerability discovery is enabled for the scan.
|
.. currentScanJobList | object | Object container for in-progress scans |
.. vulnerabilityScanOption | string |
Setting that defines which vulnerabilities to scan for. Allowed values: all , critical .
|
.. surveyConfigDTO | object | Object container for scan configuration details. |
.. .. sensorWithIpPortDTO | object | Object container for IP/port configuration details. |
.. .. ipInclusionList | string |
IPs to include in the scan. Supported formats are individual IPs, IP range, CIDR, and FQDNs. Example for IP format: 104.20.67.46 Example for FQDN format: digicert.com Note: Loopback IP "127.0.0.1" is not allowed to scan. |
.. .. includedPorts | string |
Ports to include in the scan. It can be individual ports or port range. |
.. .. openPorts | array |
A list of the open ports scanned. Used in scenarios where the host is unresponsive to ping. |
.. ..ipExclusionList | string |
IPs to exclude in the scan. Supported formats are individual IPs, IP range, CIDR, and FQDNs. Example for IP format: 104.20.67.46 Example for FQDN format: digicert.com Note: Loopback IP "127.0.0.1" is not allowed to scan. |
.. .. licenseKey | string | Sensor license key to create scan. |
.. .. portSelectionChoice | string | Select the default port or choose from All/custom ports. |
.. daysToRun | integer |
Days when the scheduled scan runs. Possible values: 1 , 2 , 3 , 4 , 5 , 6 ,7 Note: 1 being Sunday.
|
.. disablePing | boolean |
Enable hosts discovery that do not respond to ping. Note: : If true , openPorts should be provided.
|
.. timezone | string |
Time zone for the scan. Format: GMT + your timezone offset. Example: -8#pacifictime
|
.. timeToComplete | int | Wait time to complete the scan. 0 implies no timeout. |
.. vulnerabilityList | string |
This is a comma separated list of the vulnerabilities to scan for. Allowed values: Heartbleed , POODLE(SSLv3) , FREAK , LogJam , DROWN , RC4 , POODLE(TLS) , BEAST , CRIME , BREACH , SWEET32 .
|
.. emulationScans | boolean |
If true , it will exclude Heartbleed and POODLE (TLS) from vulnerability discovery.
|
.. sni | boolean | Enable the Server Name Indication (SNI) for your scan. |
.. extraTlsProtocolsDiscovery | boolean |
If true , the protocols discovery will be enabled for SSLv2, SSLv3 and TLSv1.1.If false , default protocols discovery will be enabled. Default protocols discovery are TLSv1.3, TLSv1.2 and TLSv1. |
.. osDiscoverable | boolean |
Include or exclude OS information. Default: false
|
.. serviceDiscoverable | boolean |
Include or exclude server application information. Default: false
|
.. monthlyRecurrenceType | string |
Day of the month specified for recurring scan. Allowed values: 1st , 2nd , 3rd , 4th , 5th Note: 1st being the first day of the month.
|
.. speed | string |
How fast the scan completes. Default: medium Allowed values: slow , medium , fast
|
.. refreshHPSInventory | string |
How often the host inventory will refresh.1 - always, 2 - monthly, 0 - never
|
.. scanOption | string |
Configure the scan settings either to custom / optimize .
|
isCipherScan | boolean |
Enable scan for ciphers configured on server. Default: false
|
emailAddress | string | Email address for the contact associated with the scan. |