Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
...
📙 You will learn
...
Info |
---|
The following endpoints available for ThreadFix 3.1 and newer. |
/api/application/queue/scans/pending
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 |
---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
api-version | 1.0 | Yes | ‘latest’ is also a valid option |
Request GET Parameters
Parameter | Value | Required | Description |
---|---|---|---|
_page | 1 | Optional |
|
_limit | 50 | Optional |
|
Sample Call:
Code Block |
---|
https://localhost/api/application/queue/scans/pending?_page=1&_limit=50 |
Sample Output:
Code Block |
---|
{
"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
} |
Pending Scans Report Mode Endpoint
/api/application/queue/scans/
...
report
Descriptor | Value |
---|---|
HTTP Method | GET |
Description | This endpoint returns all scans that have completed successfully or failed within the last 30 days. |
Required Permission |
...
View Scans Queue |
Version Introduced |
...
3. |
...
1. |
...
0 |
Request Header Parameters
Parameter | Value | Required | Description |
---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
...
api-version | 1.0 |
...
Optional
...
_limit
...
10
...
Optional
...
_sort
...
-modifiedDate
Yes | ‘latest’ is also a valid option |
Request GET Parameters
Parameter | Value | Required | Description |
---|---|---|---|
_page | 1 | Optional |
|
_limit | 50 | Optional |
|
Sample Call:
Code Block |
---|
https://localhost/api/application/queue/scans/report?_page=1&_limit=50 |
Sample Output:
Code Block |
---|
...
{
"content": [
{
"id": "f21e9c50-2ddc-11ec-9fca-6bac6fa4384a",
"active": true,
"createdDate": "2021-10-15T17:25:51+00:00",
"modifiedDate": "2021-10-15T17:58:29+00:00",
"orgId": 3,
"appId": 11,
"primaryChannelTypeId": 27,
"userId": 1,
"scanId": 15,
"jobId": "11d9da17-018f-470c-93b8-d769f619445b",
"appName": "App 3-9",
"primaryChannelTypeName": "AppScan Source",
"importType": "FILE_UPLOAD",
"sourceNameCount": 1,
"sourceName": "[\"165072_WebGoat1.ozasmt\"]",
"processingStartTime": "2021-10-15T17:25:53+00:00",
"requestTime": "2021-10-15T17:25:51+00:00",
"endTime": "2021-10-15T17:58:29+00:00",
"importTime": "2018-04-23T18:11:09.000+00:00",
"updatedDate": "2018-04-23T18:11:09.000+00:00",
"pendingScanStatus": "COMPLETED",
"totalParsedFindingCount": 1918,
"combinedScan": true,
"overrideNewestScan": false
},
{
"id": "73b5380f-2c4e-11ec-abdf-8dd38f08e4cc",
"active": true,
"createdDate": "2021-10-13T17:53:20+00:00",
"modifiedDate": "2021-10-13T18:11:09+00:00",
"orgId": 3,
"appId": 5,
"primaryChannelTypeId": 27,
"userId": 1,
"scanId": 5,
"jobId": "8f509832-5c7d-4391-9792-be44a67c2c44",
"appName": "App 3-3",
"primaryChannelTypeName": "AppScan Source",
"importType": "FILE_UPLOAD",
"sourceNameCount": 1,
"sourceName": "[\"WebGoat_Benchmark_LargeScan.ozasmt\"]",
"processingStartTime": "2021-10-13T17:55:59+00:00",
"requestTime": "2021-10-13T17:53:20+00:00",
"endTime": "2021-10-13T18:11:09+00:00",
"importTime": "2015-05-18T04:01:51.000+00:00",
"updatedDate": "2015-05-18T04:01:51.000+00:00",
"pendingScanStatus": "FAILED",
"totalParsedFindingCount": 52836,
"combinedScan": true,
"overrideNewestScan": false
},
{
"id": "3b063f6c-2b61-11ec-93a8-dd08ac106256",
"active": true,
"createdDate": "2021-10-12T13:35:14+00:00",
"modifiedDate": "2021-10-12T13:37:04+00:00",
"orgId": 3,
"appId": 4,
"primaryChannelTypeId": 11,
"remoteProviderEntityId": 5,
"scanId": 4,
"jobId": "0da29c2b-a116-443a-ae82-ef63733a9d95",
"orgName": "Team 3",
"appName": "App 3-2",
"primaryChannelTypeName": "Checkmarx",
"remoteProviderEntityName": "Checkmerks 1",
"importType": "REMOTE_PROVIDER_IMPORT_TYPE",
"sourceNameCount": 1,
"sourceName": "[\"checkmerks1 App 10 (/CxServer/SP/Partners/Denim Group)\"]",
"processingStartTime": "2021-10-12T13:35:41+00:00",
"requestTime": "2021-10-12T13:35:14+00:00",
"endTime": "2021-10-12T13:37:04+00:00",
"importTime": "2021-10-12T08:35:14.000+00:00",
"updatedDate": "2021-10-12T08:35:14.000+00:00",
"pendingScanStatus": "COMPLETED",
"totalParsedFindingCount": 2772,
"combinedScan": false,
"overrideNewestScan": false
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"offset": 0,
"pageNumber": 0,
"pageSize": 50,
"unpaged": false,
"paged": true
},
"totalElements": 3,
"totalPages": 1,
"last": true,
"size": 50,
"number": 0,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"first": true,
"numberOfElements": 42,
"empty": false
} |
Page Tree | ||||
---|---|---|---|---|
|