Skip to main content

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.

Related topic

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

Example requests and responses

Request parameters

Name

Req/Opt

Type

Description

accountId

required

string

Account ID.

searchCriteriaList

optional

array

Filter results by specified values. For definitions, see the Filter options for searchCriteriaList table below.

Example:

searchCriteriaList:[
  {
    "key":"state",
    "operation":"EQUALS",
    "value":["ACTIVE"]
  }
]

divisionId

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 the error code 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

State 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

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