Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/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 Introduced | 2.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:
| Code Block | ||
|---|---|---|
| ||
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?apiKey={UserApiKey} |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": "Comment added successfully."
} |
| Page Tree | ||
|---|---|---|
|