AttackForge Enterprise & AttackForge Core
Powered By GitBook
UpdateProjectById
This method can be used for the following functionality: Update a project by it's Id.

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 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)
Project Id.
Example:
1
PUT /api/ss/project/5eab99471e18050942c7607a HTTP/1.1
Copied!
name (string) (optional)
Name of the project.
Example:
1
{
2
"name": "..."
3
}
Copied!
code (string) (optional)
Project code.
Example:
1
{
2
"code": "..."
3
}
Copied!
groups (array of strings) (optional)
Groups to link to the project. Must match exact group names.
Example:
1
{
2
"groups": ["...", "...", "..."]
3
}
Copied!
startDate (string) (optional)
Project start date. String in YYYY-MM-DD format.
Example:
1
{
2
"startDate": "2020-01-01"
3
}
Copied!
endDate (string) (optional)
Project end date. String in YYYY-MM-DD format.
Example:
1
{
2
"endDate": "2020-01-05"
3
}
Copied!
scoringSystem (string) (optional)
Scoring system to be used on the project. Must be either Manual or CVSSv3.1.
Example:
1
{
2
"scoringSystem": "CVSSv3.1"
3
}
Copied!
isOnHold (string) (optional)
Whether project is currently On-Hold. Must be either Yes or No.
Example:
1
{
2
"isOnHold": "Yes"
3
}
Copied!
isOnHoldReason (string) (optional)
If project is On-Hold, or is now Off-Hold - include a reason. This will be sent in email to project team informing status change.
Example:
1
{
2
"isOnHoldReason": "The environment is currently experiencing issues and is not working."
3
}
Copied!

Example

The following example is a cURL request to update a project by its identifier (Id).

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X PUT 'https://demo.attackforge.com/api/ss/project/5e6881d12fdbcd0a5af71e8c' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
2
"name": "ACME Digital Web App Pentest",
3
"code": "DEMO9999",
4
"groups": ["ACME Corp Digital Team"],
5
"startDate": "2020-01-05",
6
"endDate": "2020-01-10",
7
"scoringSystem": "CVSSv3.1",
8
"isOnHold": "Yes",
9
"isOnHoldReason": "The environment is currently experiencing issues and is not working."
10
}'
Copied!

Response

Response contains a project object.
1
{
2
"project": {
3
"id": "...",
4
"created": "...",
5
"last_updated": "...",
6
"name": "...",
7
"code": "...",
8
"groups": ["...", "...", "..."],
9
"startDate": "...",
10
"endDate": "...",
11
"scoring_system": "...",
12
"isOnHold": "..."
13
}
14
}
Copied!
Last modified 3mo ago