Skip to main content

List scheduled jobs

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

Use this endpoint to get a list of information about all scheduled jobs for a scan.

Example requests and responses

Request parameters

Name

Req/Opt

Type

Description

accountId

required

string

Account ID.

divisionId

required

integer

Division ID.

surveyDefId

required

integer

Survey definition ID of the scan. To get a list of surveyDefId values for your scans, use the scan list endpoint.

startIndex

optional

integer

Start at the specified index.

Default: 1

pageSize

optional

integer

Number of records per page.

Allowed values: 0 to 512.

Response parameters

Name

Type

Description

error

object

Includes the error code if any.

data

object

Object container for response.

.. scanJobDTOList

array

Array of objects with details about scheduled jobs for the scan.

.. .. jobId

string

Scan job ID.

.. .. startTime

string

Start time for the scheduled scan.

Example: 1596781119

Note: startTime value should be 0 when the frequencytype is onetime

.. .. state

integer

State of the scan. For definitions, see the Scan states table below.

totalCount

integer

Total number of scans in account.

currentCount

integer

Number of scans currently visible.

Scan states

State

Value

10

IN_PROGRESS

11

COMPLETED

12

FAILED

13

PARTIAL

15

IDLE

16

SKIPPED

19

CANCELLED