Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/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 Introduced | 2.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. |
| removeCommentTags | Boolean | No | Set to "true" to remove comment tag from vulnerability. |
| addCommentTags | Boolean | No | Set to "true" to add comment tag to vulnerability |
Sample Call:
| Code Block | ||
|---|---|---|
| ||
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:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": "Comment updated successfully."
} |
| Page Tree | ||
|---|---|---|
|