AttackForge Enterprise & AttackForge Core
Powered By GitBook
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

1
POST /api/ss/vulnerability/:vulnerabilityId/remediationNote HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

vulnerabilityId (string)
Id of the vulnerability.
Example:
1
POST /api/ss/vulnerability/5e8ee4657be05608d16c2e01/remediationNote HTTP/1.1
Copied!
projectId (string)
Id of the project.
Example:
1
{
2
"projectId": "..."
3
}
Copied!
note (string)
Remediation note.
Example:
1
{
2
"note": "..."
3
}
Copied!

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.
1
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 '{
2
"projectId": "5e7c29afa3362408cf502a11",
3
"note": "This issue has been fixed in release v1.1"
4
}'
Copied!

Response

Response contains a created remediation note object.
1
{
2
"note": {
3
"id": "...",
4
"note": "..."
5
}
6
}
Copied!
Last modified 1yr ago