Update cloud scan

  2 minute read  

POST https://daas.digicert.com/apicontroller/v1/scan/updateCloudScan
Use this endpoint to update or modify the cloud scan settings.

For more information on cloud scan, see Discovery cloud scan service.

Example requests and responses

cURL

curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/scan/updateCloudScan' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cloudScanSurveyConfigDTO": {
        "ipInclusionList": "yahoo.com",
        "ipExclusionList": "",
        "isExtraTlsProtocolsScan": false,
        "includedPorts": [
            "443"
        ]
    },
    "accountId": 1419609,
    "divisionId": 304778,
    "action": "saveAndRunNow"
}'

200 OK

{
    "error": null,
    "data": "Cloud scan updated successfully."
}

Request parameters

NameReq/OptTypeDescription
cloudScanSurveyConfigDTOrequiredobjectObject container for cloud scan configuration details.
.. ipInclusionListrequiredstringIPs to include in the cloud scan. This can be a comma-separated list.
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.
.. ipExclusionListrequiredstringIPs to exclude in the cloud scan. This can be a comma-separated list.
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.
.. isExtraTlsProtocolsScanoptionalbooleanIf true, the protocols scan will be enabled for SSLv2, SSLv3 and TLSv1.1. If false, default protocols scan will be enabled.
Default protocols scan are TLSv1.3, TLSv1.2 and TLSv1.
.. includedPortsrequiredarrayPorts to include in the cloud scan. It can be individual ports or port range.
accountIdrequiredstringAccount ID.
divisionIdrequiredintegerDivision ID.
actionoptionalstringAction performed to update the cloud scan.

Response parameters

NameTypeDescription
errorobjectIncludes the error code, if any.
datastringMessage for cloud scan updated with the next scheduled run.