Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/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 |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
List of Scan Statuses
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 |
DONE | 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. |
Sample Call:
| Code Block | theme | Eclipse
|---|
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/6/pendingScan/41/status |
Sample Output:
Values for modifiedDate and time are returned as Epoch time in milliseconds.
| Code Block | |
|---|---|
| Eclipse | {
"message": "Generating FindingsScan Processing Completed. Statistics Update Queued.",
"success": true,
"responseCode": -1,
"object": {
"id": 2,
"modifiedDate": 411570117773000,
"active": true,
"fileDataList": [
{
"id": 56,
12,
"originalName": "WebGoat_Benchmark_ShortenedScan.ozasmt"
}
],
contoso.fpr"
}
],
"appId": 6,
"errorMessage": null,
"status": "FINDINGS_GENERATINGDONE",
"error": false,
"scanId": 12,
"type": "upload",
"name": "WebGoat_Benchmark_ShortenedScan.ozasmtcontoso.fpr",
"time": 14909079590001570117773000,
"scanMessage": "Generating Findings"
Scan Processing Completed. Statistics Update Queued."
}
} |
| Page Tree | ||
|---|---|---|
|