Scanliste

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 adding a scan and configuring it, see Set up and run a scan

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": [],
    "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

Name Req/Opt Type Description
accountId required string Account ID.
searchCriteriaList optional array Filter results by specified values.
For definitions, see the Search criteria listtable below.
Example: searchCriteriaList:[{"key":"state","operation":"EQUALS","value":["ACTIVE"]}]
divisionIds required array Division IDs.
sortOrder optional string Sort direction.
Allowed values: ASC (ascending: 0-9, A-Z), DESC (descending: 9-0, Z-A)
Default: ASC

Response parameters

Name Type Description
error object Includes error codes, if any.
data object Object container for response.
.. id integer ID associated with the scan, also known as the surveydefid.
.. name string Friendly name the administrator gave to the CertCentral Discovery scan.
.. type string Source used to identify the scan.
Allowed values: Cloud, Agent, Sensor.
.. frequency string How often the scan will run.
Allowed values: One Time, Daily, Weekly, Monthly.
.. state string Status of the scan.
Allowed values: ACTIVE, SUSPENDED, DELETED, INPROGRESS.
.. latestResult string Result of latest scan run.
Allowed values: COMPLETED, FAILED, PARTIAL, SKIPPED.
.. scheduled string Scan time scheduled or not.
Allowed values: Yes, No.
.. divisionId integer Division ID.

Filter options for searchCriteriaList

The array includes key, operation and value.

Key Operation Value
name EQUALS Scan name
sensor EQUALS Sensor name
state EQUALS ACTIVE, SUSPENDED, DELETED, INPROGRESS
latestResult EQUALS IN_PROGRESS, COMPLETED, FAILED, PARTIAL, IDLE, SKIPPED, CANCELLED
scantype EQUALS Cloud, Agent, Sensor
frequency EQUALS One Time, Daily, Weekly, Monthly
ipAddress EQUALS IP/FQDN