As we reach the end of September 2024, ThreadFix version 3.x on-premises has officially reached its End-of-Life. Therefore, there is no longer support or updates for this version of the product. We have fully transitioned our product and development teams to focus ThreadFix SaaS and migrating all customers over from the on-premises versions. Our Customer Success and Support teams are here to help you in migrating to ThreadFix SaaS and maximizing the value you see from this improved offering from Coalfire. This is the next phase of ThreadFix and our team is looking forward to continuing to support you on this journey.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

/rest/{version}/scans/{scanId}/download

Descriptor

Value

HTTP Method

GET

Description

Outputs the scan file associated with the given Scan ID and name. Be sure to pipe the response into a file.

Required Permission

Download Scans

Version Introduced

2.5.0.2

Changes in 2.5.1.13

Adds a new parameter to get scan files without needing names.

Changes in 2.8

Changed required permission.

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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

Request GET Parameters

Parameter

Value

Required

Description

scanFileName

String

Yes*

File name of the original file uploaded to ThreadFix.

file

Integer

Yes*

Index of the file to download if there were multiple files uploaded as one scan.  Otherwise use file=0.

*Either scanFileName or file must be provided, but not both. 

Sample Calls:

curl --insecure -H 'Accept: application/json' -H 'Authorization: APIKEY {apiKey}' http://localhost:8080/threadfix/rest/latest/scans/34/download?&scanFileName=appscan-php-demo.xml > appscan-php-demo.xml
curl --insecure -H 'Accept: application/json' -H 'Authorization: APIKEY {apiKey}' http://localhost:8080/threadfix/rest/latest/scans/34/download?&file=0 > appscan-php-demo.xml

Sample Output:

The output for this REST call is the scan file the user wishes to download.  Ensure it is piped into the proper file type (xml, fpr, zip, etc.).

  • No labels

[www.threadfix.it] | [www.coalfire.com]
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.