CreateProjectWorkspaceNote

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

POST /api/ss/project/:id/workspace/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/workspace/note HTTP/1.1

title (string)

Title of the note.

Example:

{
   "title": "..."
}

details (string)

Details of the note.

Example:

{
   "details": "..."
}

details_type (string) (optional)

Must be either PLAINTEXT or RICHTEXT. Defaults to PLAINTEXT if not specified.

Example:

{
   "details_type": "PLAINTEXT"
}

assets (array of strings) (optional)

Asset IDs for each asset on the project which is linked to the note.

Example:

{
   "assets": ["5fd2aa6b82fba0091dee695b", "5f6ae8b97b1bc80867f90301"]
}

Example

The following example is a cURL request to create a new workspace 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/workspace/note' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "title": "New Note",
  "details": "Here are some note details",
  "details_type": "PLAINTEXT",
  "assets": ["5fd2aa6b82fba0091dee695b", "5f6ae8b97b1bc80867f90301"]
}'

Response

Response contains a result.

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