Use this endpoint to update or modify the scan settings.
For more information on editing and updating scan settings, see Edit a scan.
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/scan/update' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"surveyConfigDTO": {
"disablePing":false,
"sensorWithIpPortDTO": [
{
"portSelectionChoice": "default",
"ipInclusionList": "www.digicert.com",
"ipExclusionList": "10.198.219.33",
"includedPorts": [
"80","443","389","636","22","143","110","465","8443","3389"
],
"licenseKey": "A79683A885D9967C",
"openPorts": null
}
],
"daysToRun": [],
"startTime": 0,
"timeToComplete": 0,
"timezone": "5:30#chennai",
"monthlyRecurrenceType": "1st",
"speed": "medium",
"refreshHPSInventory": "always",
"isCreateFlow": true,
"scanOption": "optimize",
"vulnerabilityList": "Heartbleed,POODLE (SSLv3),BEAST,FREAK,LogJam,DROWN,RC4,POODLE (TLS)",
"sni": false,
"isOsDiscoverable": false,
"isServiceDiscoverable": false,
"emulationScans": false,
"extraTlsProtocolsDiscovery": false
},
"accountId": "5153184",
"divisionId": 677793,
"surveyName": "ed34a1d0-1829-49e5-afb4-12fc1eb18192",
"id": 293514,
"frequencyType": "onetime",
"vulnerabilityScanOption": "critical"
}'
[
{
"error": null,
"data": "Changes were saved. Your scan will run as scheduled."
}
]
Name | Req/Opt | Type | Description |
---|---|---|---|
surveyConfigDTO | required | object | Object container for scan configuration details. |
.. disablePing | optional | boolean |
Enable hosts discovery that do not respond to ping. Note: : If true , openPorts should be provided.
|
.. sensorWithIpPortDTO | required | array | Array of objects with IP/port configuration details. |
.. .. portSelectionChoice | required | string | Select the default port or choose from all/custom ports. |
.. .. ipInclusionList | required | 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. |
.. .. ipExclusionList | optional | 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. |
.. .. includedPorts | required | array |
Ports to include in the scan. It can be individual ports or port range. |
.. .. licenseKey | required | string | Sensor license key to create scan. |
.. .. portSelectionChoice | required | string | Select the default port or choose from all/custom ports. |
.. .. openPorts | required | array |
A list of the open ports scanned. Used in scenarios where the host is unresponsive to ping. |
.. startTime | required | 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
|
.. timeToComplete | optional | integer |
Wait time to complete the scan. 0 implies no timeout.
|
.. timezone | optional | string |
Time zone for the scan. Format: GMT + your timezone offset Example: -8#pacifictime
|
.. monthlyRecurrenceType | optional | 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 | optional | string |
How fast the scan completes. Default : medium Allowed values: slow , medium , fast
|
.. refreshHPSInventory | required | string |
How often the host inventory will refresh.1 - always, 2 - monthly, 0 - never
|
.. isCreateFlow | required | boolean |
Use true when creating a new scan, and false when updating an existing scan.
|
.. scanOption | optional | string |
Configure the scan settings either to custom / optimize .
|
.. sni | optional | boolean | Enable the Server Name Indication (SNI) for your scan. |
.. vulnerabilityList | required | 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 .
|
.. isOsDiscoverable | optional | boolean |
Include or exclude OS information. Default: false
|
.. isServiceDiscoverable | required | boolean |
Include or exclude server application information. Default: false
|
.. emulationScans | optional | boolean |
If true , it will exclude Heartbleed and POODLE (TLS) from vulnerability discovery.
|
.. extraTlsProtocolsDiscovery | optional | 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. |
accountId | required | string | Account ID. |
divisionId | required | integer | Division ID. |
surveyName | required | string |
Friendly name provided for the scan. Max length: 80 characters. |
id | required | integer |
ID associated with the scan, also known as surveydefid .
|
frequencyType | required | string |
How often the scan will run. Allowed values: onetime , daily , weekly , monthly
|
vulnerabilityScanOption | optional | string |
Scan for any vulnerabilities. Default: critical Allowed values: all , critical
|
Name | Type | Description |
---|---|---|
error | object | Includes the error code, if any. |
data | string | Message for scan updated with the next scheduled run. |