CreateRemediationNote

This method can be used for the following functionality: Create new remediation note for a vulnerability on a project that you have access to.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

POST /api/ss/vulnerability/:vulnerabilityId/remediationNote HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

vulnerabilityId (string)

Id of the vulnerability.

Example:

POST /api/ss/vulnerability/5e8ee4657be05608d16c2e01/remediationNote HTTP/1.1

projectId (string)

Id of the project.

Example:

{
   "projectId": "..."
}

note (string)

Remediation note.

Example:

{
   "note": "..."
}

note_type (string) (optional)

Must be either PLAINTEXT or RICHTEXT. Defaults to PLAINTEXT if not specified.

Example:

{
   "note_type": "PLAINTEXT"
}

Example

The following example is a cURL request to create a new remediation note on a vulnerability for a project.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' ' parameter.

curl -X POST 'https://demo.attackforge.com/api/ss/vulnerability/5e8ee4657be05608d16c2e01/remediationNote' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "projectId": "5e7c29afa3362408cf502a11",
  "note": "This issue has been fixed in release v1.1"
}'

Response

Response contains a created remediation note object.

{
   "note": {
      "id": "...",
      "note": "...",
      "note_html": "...",
      "note_type": "PLAINTEXT/RICHTEXT"
   }
}