Scan list

  2 minute read  

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.

For more information on discovery scan and its details, see Set up and run a scan.

Example requests and responses

cURL

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

{
    "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

NameReq/OptTypeDescription
accountIdrequiredstringAccount ID.
searchCriteriaListoptionalarrayFilter results by specified values. For definitions, see the Filter options for searchCriteriaList table below.
Example:
searchCriteriaList:[ { "key":"state", "operation":"EQUALS", "value":["ACTIVE"] } ]
divisionIdrequiredarrayDivision IDs.
sortOrderoptionalstringSort direction.
Allowed values: ASC (ascending: 0-9, A-Z), DESC (descending: 9-0, Z-A)
Default: ASC

Response parameters

NameTypeDescription
errorobjectIncludes the error code if any.
dataobjectObject container for response.
.. idintegerID associated with the scan, also known as the  surveyDefId
.. namestringFriendly name the administrator gave to the CertCentral Discovery scan.
.. typestringSource used to identify the scan.
Allowed values: Cloud, Agent, Sensor.
.. frequencystringHow often the scan will run.
Allowed values: One Time, Daily, Weekly,Monthly.
.. statestringState of the scan.
Allowed values: ACTIVE, SUSPENDED, DELETED,INPROGRESS.
.. latestResultstringResult of latest scan run.
Allowed values: COMPLETED, FAILED, PARTIAL,SKIPPED.
.. scheduledstringScan time scheduled or not.
Allowed values: YES, NO
.. divisionIdintegerDivision ID.

Filter options for searchCriteriaList

KeyOperationValue
nameEQUALSScan name
sensorEQUALSSensor name
stateEQUALSACTIVE ,SUSPENDED,DELETED, INPROGRESS
latestResultEQUALSIN_PROGRESS, COMPLETED, FAILED, PARTIAL, IDLE, SKIPPED, CANCELLED
scantypeEQUALSOne Time, Daily, Weekly, Monthly
ipAddressEQUALSIP/FQDN