CreateProjectNote

This method can be used for the following: Create new project note on a project that you have 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/project/:id/note HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the project.

Example:

POST /api/ss/project/5f63de24fa1c9208d3e140b0/note HTTP/1.1

note (string)

Details of the note.

Example:

{
   "note": "..."
}

is_private (boolean) (optional)

Whether note is private or not.

Example:

{
   "is_private": true
}

is_exported_to_report (boolean) (optional)

Whether note is exported into reports or not.

Example:

{
   "is_exported_to_report": false
}

Example

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

Request

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

curl -X POST 'https://demo.attackforge.com/api/ss/project/5f63de24fa1c9208d3e140b0/note' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "note": "New Note",
  "is_private": true,
  "is_exported_to_report": false
}'

Response

Response contains a result.

{
   "result": "Successfully Created Project Note"
}