List past jobs

2 minute read

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

Use this endpoint to get a list of information about past scan jobs, including the start and end time.

Example requests and responses

cURL

curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/scan/pastScanJobs' \
--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": "294443",
                "percentageCompleted": 20.0,
                "state": 11,
                "duration": 108,
                "startTime": 1588848332168,
                "endTime": 1588848440203,
                "vulStartTime": null,
                "vulEndTime": null,
                "vulState": null,
                "vulEnabled": true,
                "emulationScans": false,
                "vulPercentageCompleted": 0.0,
                "vulDuration": null,
                "hasResults": false
            }
        ],
        "totalCount": 1,
        "currentCount": 1
    }
}

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.
.. .. percentageCompleted	float	Scan percentage completed.
.. .. state	integer	State of the scan. For definitions, see the Scan states table below.
.. .. duration	integer	Duration used for the scan.
.. .. startTime	integer	Start time of the scan.
.. .. endTime	integer	End time of the scan.
.. .. vulStartTime	integer	Vulnerability discovery start time.
.. .. vulEndTime	integer	Vulnerability discovery end time.
.. .. vulState	integer	Status of the vulnerability.
.. .. vulEnabled	integer	Whether vulnerability is enabled.
.. .. emulationScans	integer	If `true`, it will exclude `Heartbleed` and `POODLE (TLS)` from vulnerability discovery.
.. .. vulPercentageCompleted	float	Vulnerability scan percentage completed.
.. .. vulDuration	integer	Vulnerability scan duration in milliseconds.
.. .. hasResults	boolean	If `true`, scan results discovered certificates.
totalCount	integer	Total number of scans in account.
currentCount	integer	Number of scans currently visible.