Filter scan

POST
https://daas.digicert.com/apicontroller/v1/scan/filter

Use this endpoint to get the list of the scans based on the filter criteria selected.

cURL
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/scan/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"searchCriteriaList":[],"filterSelected":"name","accountId":"5153184","divisionIds":[]}'
200 OK
{
    "error": null,
    "data": {
        "filterName": "name",
        "displayName": "name",
        "values": [
            "02april2020 01",
            "02Jul2019 01",
            "02Jul2019 01_1",
            "02Jul2019 03",
            "03Feb2020 01",
            "04may2020 01",
            "0507 tls",
            "05may2020 01",
            "06Feb2020 01",
            "06feb2020 03",
            "07feb2020 01",
            "vu18pi0b57ReinstateScan",
            "vur0p7pfsfVulScan",
            "vvf3bd61e4autoCreateScan",
            "vvggbvgghvautoCreateScan",
            "ジテンドラ..ヴァゲラ"
        ]
    }
}

Request parameters

Name Req/Opt Type Description
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"]}]
filterSelected required string The value to show in the results for each scan that meets the search criteria.
Allowed values: name, sensor, state, latestResult,scantype, ipAddress.
accountId required string Account ID.
divisionIds required array Division IDs.

Response parameters

Name Type Description
error object Includes error codes, if any.
data object Object with information about the filter results.
.. filterName string Specified filter key.
.. displayName string Friendly name of the filter key as it appears in the UI.
.. values array List of scans that meet the search criteria. The value shown for each scan is the value set for the filterSelected parameter in the request body.

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