PatchRemediationNoteFile

This method can be used for the following: Patch a remediation note file for a project user has Edit 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

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

Path

vulnerabilityId (string)

Identifier for the vulnerability.

Example:

PATCH /api/ss/vulnerability/5f5ebf3b31ff1d08c1e5fa91/remediationNote/:remediationNoteId/file/:file HTTP/1.1

remediationNoteId (string)

Identifier for the remediation note.

Example:

PATCH /api/ss/vulnerability/:vulnerabilityId/remediationNote/5f5ebf3b31ff1d08c1e5fa91/file/:file HTTP/1.1

file (string)

Storage name for the evidence file.

Example:

PATCH /api/ss/vulnerability/:vulnerabilityId/remediationNote/:remediationNoteId/file/o23kuixb8c34fm4gbehndpwzuemegvufjzc7jfkh5xlrmlswl4smfyslj65vuupcv5cc21hizhiiysa1bh5ibiwio17vzpzr63n6xtfh9yvzso4ete6qyh55ez5o6in1 HTTP/1.1

Body

name (string)

File name.

Example:

{
  "name": "network-diagram.png"
}

caption (string)

File caption.

Example:

{
  "name": "Network diagram captured during testing"
}

Example

The following example is a cURL request to patch a file for a remediation note on a project.

Request

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

curl -X PATCH 'https://demo.attackforge.com/api/ss/vulnerability/5f5ebf3b31ff1d08c1e5fa91/remediationNote/5f5ebf3b31ff1d08c1e5fb61/file/o23kuixb8c34fm4gbehndpwzuemegvufjzc7jfkh5xlrmlswl4smfyslj65vuupcv5cc21hizhiiysa1bh5ibiwio17vzpzr63n6xtfh9yvzso4ete6qyh55ez5o6in1' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
    "name": "network-diagram.png",
    "caption": "Network diagram captured during testing"
}'

Response

Response contains a status or error message.

{
   "status": "ok"
}