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.

cURL
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/scan/futureScanJobs' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"accountId":"5153184","divisionId":677793,"surveyDefId":293514,"startIndex":1,"pageSize":10}'
200 OK
{
    "error": null,
    "data": {
        "scanJobDTOList": [
            {
                "jobId": "1591099200000",
                "startTime": 1591099200000,
                "state": 11
            },
            {
                "jobId": "1594123200000",
                "startTime": 1594123200000,
                "state": 11
            },
            {
                "jobId": "1596542400000",
                "startTime": 1596542400000,
                "state": 11
            },
            {
                "jobId": "1598961600000",
                "startTime": 1598961600000,
                "state": 11
            },
            {
                "jobId": "1601985600000",
                "startTime": 1601985600000,
                "state": 11
            },
            {
                "jobId": "1604404800000",
                "startTime": 1604404800000,
                "state": 11
            },
            {
                "jobId": "1606824000000",
                "startTime": 1606824000000,
                "state": 11
            },
            {
                "jobId": "1609848000000",
                "startTime": 1609848000000,
                "state": 11
            },
            {
                "jobId": "1612267200000",
                "startTime": 1612267200000,
                "state": 11
            },
            {
                "jobId": "1614686400000",
                "startTime": 1614686400000,
                "state": 11
            }
        ],
        "totalCount": 2147483647,
        "currentCount": 10
    }
}

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 error codes, 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