AttackForge Enterprise & AttackForge Core
Powered By GitBook
UpdateProjectWorkspaceNote
This method can be used for the following: Update existing workspace 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
PUT /api/ss/project/:id/workspace/note/:noteId 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
PUT /api/ss/project/5f63de24fa1c9208d3e140b0/workspace/note/:noteId HTTP/1.1
Copied!
noteId (string)
Id of the note.
Example:
1
PUT /api/ss/project/:id/workspace/note/5fd2b313ee79ce0a79f213c1 HTTP/1.1
Copied!
title (string) (optional)
Title of the note.
Example:
1
{
2
"title": "..."
3
}
Copied!
details (string) (optional)
Details of the note.
Example:
1
{
2
"details": "..."
3
}
Copied!
assets (array of strings) (optional)
Asset IDs for each asset on the project which is linked to the note.
Example:
1
{
2
"assets": ["5fd2aa6b82fba0091dee695b", "5f6ae8b97b1bc80867f90301"]
3
}
Copied!
is_deleted (boolean) (optional)
Whether note is deleted or not.
Example:
1
{
2
"is_deleted": false
3
}
Copied!

Example

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

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X PUT 'https://demo.attackforge.com/api/ss/project/5f63de24fa1c9208d3e140b0/workspace/note/5fd2b313ee79ce0a79f213c1' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
2
"title": "Updated Note",
3
"details": "Here are some updated note details",
4
"assets": ["5fd2aa6b82fba0091dee695b"],
5
"is_deleted": false
6
}'
Copied!

Response

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