As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Get Document Attached to a Vulnerability - API

/rest/{version}/documents/{documentId}/download


Descriptor

Value

HTTP Method

GET

Description

Displays content of document files

Required Permission

Read Access (Any Role)

Version Introduced2.5.1.17


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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


Sample Call:


curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" GET http://localhost:8080/threadfix/rest/latest/documents/1/download > remediation.txt


Sample Output:

The output for this REST call is the scan file you want to download.  Make sure you pipe it into the proper file type (xml, fpr, zip, etc.).

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.