Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added version and permission

/rest/applications/{appId}/pendingScan/{pendingScanId}/status

 

Descriptor

Value

HTTP Method

GET

Description

Checks the status of a scan after it has been queued.

Restricted

 Required Permission

Upload Scans 

Version Introduced2.5.0

 

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

 

Sample Call:

Code Block
themeEclipse
curl --insecure -H 'Accept: application/json' http://localhost:8080/threadfix/rest/applications/6/pendingScan/41/status?apiKey={apiKey}

 

Sample Output:


Code Block
themeEclipse
{
    "message": "Generating Findings",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 41,
        "active": true,
        "fileDataList": [
            {
                "id": 56,
                "originalName": "WebGoat_Benchmark_ShortenedScan.ozasmt"
            }
        ],
        "appId": 6,
        "errorMessage": null,
        "status": "FINDINGS_GENERATING",
        "error": false,
        "type": "upload",
        "name": "WebGoat_Benchmark_ShortenedScan.ozasmt",
        "time": 1490907959000,
        "scanMessage": "Generating Findings"
    }
}


Page Tree
rootScans API