AttackForge Enterprise

UpdateExecSummaryNotes

This method can be used for the following functionality: Update executive summary notes on a project that this user must 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/:projectId/execSummaryNotes 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:

PUT /api/ss/project/5e7c29afa3362408cf502a11/execSummaryNotes HTTP/1.1

exec_summary_notes (string)

Executive summary notes.

Example:

{
"exec_summary_notes": "..."
}

Example

The following example is a cURL request to update the executive summary notes on a project.

Request

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

curl -X PUT 'https://demo.attackforge.com/api/ss/project/5e7c29afa3362408cf502a11/execSummaryNotes' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
"exec_summary_notes": "The key findings for this pentest include..."
}'

Response

Response contains a status.

{
"status": "Exec Summary Notes Updated"
}