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

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

Query

id (string)
Id of the project.
Example:
1
POST /api/ss/project/5f63de24fa1c9208d3e140b0/note HTTP/1.1
Copied!
note (string)
Details of the note.
Example:
1
{
2
"note": "..."
3
}
Copied!
is_private (boolean) (optional)
Whether note is private or not.
Example:
1
{
2
"is_private": true
3
}
Copied!
is_exported_to_report (boolean) (optional)
Whether note is exported into reports or not.
Example:
1
{
2
"is_exported_to_report": false
3
}
Copied!

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.
1
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 '{
2
"note": "New Note",
3
"is_private": true,
4
"is_exported_to_report": false
5
}'
Copied!

Response

Response contains a result.
1
{
2
"result": "Successfully Created Project Note"
3
}
Copied!
Last modified 7mo ago