AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetProjectNotes
This method can be used for the following: Get project notes for a project 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
GET /api/ss/project/:id/notes 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)
Identifier for the project.
Example:
1
GET /api/ss/project/5f63de24fa1c9208d3e140b0/notes HTTP/1.1
Copied!

Example

The following example is a cURL request to get project notes by the project id.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X GET 'https://demo.attackforge.com/api/ss/project/5f63de24fa1c9208d3e140b0/notes' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

Response contains an array of notes.
1
[
2
{
3
"note": "...",
4
"is_private": true,
5
"is_exported_to_report": true,
6
"created": "...",
7
"created_by": "...",
8
"last_updated": "...",
9
"id": "..."
10
}
11
]
Copied!
Last modified 7mo ago