Scan list

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": [
        677793
    ],
    "isFromWallAlert": false
}'

200 OK

{
    "error": null,
    "data": [
        {
            "id": 292888,
            "name": "02april2020 01",
            "type": "Daily",
            "state": "SUSPENDED",
            "latestResult": "COMPLETED",
            "scheduled": "Yes",
            "divisionId": 677793
        },
        {
            "id": 291070,
            "name": "02Jul2019 01",
            "type": "Daily",
            "state": "INPROGRESS",
            "latestResult": "FAILED",
            "scheduled": "Yes",
            "divisionId": 677793
        },
        {
            "id": 291071,
            "name": "02Jul2019 01_1",
            "type": "One Time",
            "state": "ACTIVE",
            "latestResult": "Unavailable",
            "scheduled": "No",
            "divisionId": 677793
        },
        {
            "id": 291024,
            "name": "02Jul2019 03",
            "type": "Monthly",
            "state": "INPROGRESS",
            "latestResult": "FAILED",
            "scheduled": "Yes",
            "divisionId": 677793
        }, 
        {
            "id": 293045,
            "name": "ジテンドラ..ヴァゲラ",
            "type": "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 list`table below. Example: `searchCriteriaList:[{"key":"state","operation":"EQUALS","value":["ACTIVE"]}]`
divisionIds	required	array	Division IDs.

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	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.

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`	`One Time`, `Daily`, `Weekly`, `Monthly`
`ipAddress`	`EQUALS`	`IP/FQDN`

Related topic

Request parameters

Response parameters

Filter options for searchCriteriaList

Sobre