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.

Update Vulnerability Comment - API

/rest/{version}/vulnerabilities/{vulnId}/vulnComment/{commentId}/update


Descriptor

Value

HTTP Method

PUT

Description

Allows update or removal of existing vulnerability comment

Required Permission

Comment on Vulnerabilities*

Version Introduced2.8.0

* The API Key used must be attached to a user with permission to add comments.


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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


Request POST Data Parameters

Parameter

Value

Required

Description

comment

String

No

The message for the comment.

commentTagIds

String

No

A comma-separated list of the Ids for any comment tags you want to attach to the comment.

removeCommentTagsBooleanNoSet to "true" to remove comment tag from vulnerability.
addCommentTagsBooleanNoSet to "true" to add comment tag to vulnerability


Sample Call:

curl --insecure -H 'content-type: application/x-www-form-urlencoded' -H 'Accept: application/json' -H 'Authorization: APIKEY {apiKey}' -X PUT --data "comment=This is a comment.&commentTagIds=5,6&removeCommentTags=true&addCommentTags=false" http://localhost:8083/threadfix/rest/latest/vulnerabilities/{vulnId}/vulnComment/{vulncommentId}/update


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Comment updated successfully."
}

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.