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.

Add Comment to Vulnerability - API

/rest/{version}/vulnerabilities/{vulnId}/addComment


Descriptor

Value

HTTP Method

POST

Description

Adds a comment to the vulnerability with the given vulnId.  The user used to submit the comment is determined by the API Key used with the call.

Required Permission

Comment on Vulnerabilities*

Version Introduced2.3.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

Yes

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.


Sample Call:

curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data "comment=This is a comment.&commentTagIds=5,6" http://localhost:8080/threadfix/rest/latest/vulnerabilities/1/addComment


Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Comment added 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.