UploadRemediationNoteFile

This method can be used for the following: Upload a file on a remediation note 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

POST /api/ss/vulnerability/:vulnerabilityId/remediationNote/:remediationNoteId/file HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

vulnerabilityId (string)

Identifier for the vulnerability.

Example:

POST /api/ss/vulnerability/5f63de24fa1c9208d3e140b0/remediationNote/:remediationNoteId/file HTTP/1.1

remediationNoteId (string)

Identifier for the remediation note.

Example:

POST /api/ss/vulnerability/:vulnerabilityId/remediationNote/5e8017d2e1385f0c58e8f4f8/file HTTP/1.1

file (multipart/form-data)

Multipart/form-data for the file to be uploaded.

Example

The following example is a cURL request to upload a file 'screenshot.png' to a remediation note on a vulnerability.

Request

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

curl -X POST 'https://localhost:3000/api/ss/vulnerability/5f63de24fa1c9208d3e140b0/remediationNote/5e8017d2e1385f0c58e8f4f8/file' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -F "[email protected]" 

Response

Response contains a status.

{   
    "status": "File Uploaded"
}