Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/applications/{appId}/scans
Descriptor | Value |
|---|---|
HTTP Method | GET |
Description | Retrieves a list of all scans uploaded to an application. |
Required Permission | Read Access (Any Role) |
Version Introduced | 2.3.0 |
Changes in 2.5.1 | Adds the updatedDate field to the response. This field is present when using older REST versions as well. |
Changes in 2.8 | Adds metadata search parameter. |
Changes in 2.8.3 | Added buildId field to the response. |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Sample Call
Request GET Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
metadata | Map | No | Filter results by metadata key / value pairs. |
Sample Call:
| Code Block |
|---|
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/1/scans
|
Sample Call with Metadata Filtering:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/applications/1/scans?apiKey={apiKey} |
metadata.foo=bar&metadata.hello=world |
Sample Output:
Values for importTime and updatedDate are returned as Epoch time in milliseconds.
| Code Block | theme | Eclipse
|---|
{
"message": "",
"success": true,
"responseCode": -1,
"object": [
{
"id": 1,
"importTime": 1309962639000,
"updatedDate": 1309962639000,
"buildId": "9231570",
"scannerName": "w3afVeracode"
}
]
} |
| Page Tree | ||
|---|---|---|
|