Pending Scans Live Mode Endpoint 3.X

The following is available for ThreadFix 3.1 and newer.

/api/application/queue/scans/pending

To obtain the authorization token, refer to the API Authentication 3.X guide.

Descriptor	Value

Descriptor	Value
HTTP Method	GET
Description	This endpoint returns all queued and processing scans.
Required Permission	View Scans Queue
Version Introduced	3.1.0

Request Header Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.
api-version	String	Yes	The version of the API to use - ‘latest’ returns the current version.

Request GET Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
_page	Integer	Optional	Page of the result set being requested.
_limit	Integer	Optional	Size of the result set page - default is 10.

Sample Call:

curl --insecure -H 'Authorization: Bearer {token}' -H 'api-version: latest' -H "Content-type: application/json" 'https://localhost/api/application/queue/scans/pending?_page=1&_limit=50'

Sample Output:

{
    "content": [
        {
            "id": "bcf594a8-3015-11ec-9fca-d9567b52cc34",
            "active": true,
            "createdDate": "2021-10-18T13:17:26+00:00",
            "modifiedDate": "2021-10-18T13:17:26+00:00",
            "orgId": 3,
            "appId": 6,
            "userId": 1,
            "appName": "App 3-4",
            "primaryChannelTypeName": "AppScan Source",
            "importType": "FILE_UPLOAD",
            "sourceNameCount": 1,
            "sourceName": "[\"165072_WebGoat1.ozasmt\"]",
            "requestTime": "2021-10-18T13:17:26+00:00",
            "pendingScanStatus": "QUEUED_FOR_IMPORT",
            "combinedScan": true,
            "overrideNewestScan": false
        },
        {
            "id": "a7737252-3015-11ec-9fca-c37a853ccbb2",
            "active": true,
            "createdDate": "2021-10-18T13:16:50+00:00",
            "modifiedDate": "2021-10-18T13:16:50+00:00",
            "orgId": 5,
            "appId": 12,
            "userId": 1,
            "appName": "App 4-1",
            "primaryChannelTypeName": "AppScan Source",
            "importType": "FILE_UPLOAD",
            "sourceNameCount": 1,
            "sourceName": "[\"WebGoat_Benchmark_LargeScan.ozasmt\"]",
            "requestTime": "2021-10-18T13:16:50+00:00",
            "pendingScanStatus": "IMPORTING",
            "combinedScan": true,
            "overrideNewestScan": false
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 50,
        "unpaged": false,
        "paged": true
    },
    "totalElements": 2,
    "totalPages": 1,
    "last": true,
    "size": 50,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "first": true,
    "numberOfElements": 2,
    "empty": false
}