You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
/rest/{version}/applications/{appId}/pendingScan/{pendingScanId}/status
Descriptor
Value
HTTP Method
GET
Description
Checks the status of a scan after it has been queued.
Required Permission
Upload Scans
Version Introduced
2.5.0
Changes in 2.7.7
Added scanId to the response when the status = DONE
scanId
DONE
Parameter
Required
Accept
String
Yes
A value of ‘application/json’ must be provided.
Status in API Response
Status in UI
QUEUED
Queued
UPLOADED
Uploaded
FINDINGS_GENERATING
Generating Findings
CHANNEL_MERGING
Merging Channel Findings
APPLICATION_MERGING
Merging Application Findings
APPLICATION_MERGED
Merging Application Findings Completed
Scan Processing Completed. Statistics Update Queued.
FINISHED_FINDING_PULLING
Findings Import From Server Finished.
SCAN_INTERRUPTED
Scan processing was interrupted
SCAN_QUEUED_FOR_DELETE
Scan queued to be deleted.
SCAN_DELETED
Scan Deleted.
LINKING_DEFECTS
Linking Defects.
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/6/pendingScan/41/status
Values for modifiedDate and time are returned as Epoch time in milliseconds.
{ "message": "Scan Processing Completed. Statistics Update Queued.", "success": true, "responseCode": -1, "object": { "id": 2, "modifiedDate": 1570117773000, "active": true, "fileDataList": [ { "id": 12, "originalName": "contoso.fpr" } ], "appId": 6, "errorMessage": null, "status": "DONE", "error": false, "scanId": 12, "type": "upload", "name": "contoso.fpr", "time": 1570117773000, "scanMessage": "Scan Processing Completed. Statistics Update Queued." } }