AttackForge Enterprise

UpdateProjectNote

This method can be used for the following: Update existing 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

PUT /api/ss/project/:id/note/:noteId HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the project.

Example:

PUT /api/ss/project/5f63de24fa1c9208d3e140b0/note/:noteId HTTP/1.1

noteId (string)

Id of the note.

Example:

PUT /api/ss/project/:id/note/5fd40d5c5af8680d1ad9eef5 HTTP/1.1

note (string) (optional)

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
}

is_deleted (boolean) (optional)

Whether note is deleted or not.

Example:

{
"is_deleted": false
}

Example

The following example is a cURL request to update an existing note for a project.

Request

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

curl -X PUT 'http://localhost:3000/api/ss/project/5f63de24fa1c9208d3e140b0/note/5fd40d5c5af8680d1ad9eef5' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
"note": "Updated Note",
"is_private": false,
"is_exported_to_report": false,
"is_deleted": false
}'

Response

Response contains a result.

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