AttackForge Enterprise

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

PUT /api/ss/project/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Project Id.

Example:

{
"id": "..."
}

name (string) (optional)

Name of the project.

Example:

{
"name": "..."
}

code (string) (optional)

Project code.

Example:

{
"code": "..."
}

groups (array of strings) (optional)

Groups to link to the project. Must match exact group names.

Example:

{
"groups": ["...", "...", "..."]
}

startDate (string) (optional)

Project start date. String in YYYY-MM-DD format.

Example:

{
"startDate": "2020-01-01"
}

endDate (string) (optional)

Project end date. String in YYYY-MM-DD format.

Example:

{
"endDate": "2020-01-05"
}

scoringSystem (string) (optional)

Scoring system to be used on the project. Must be either Manual or CVSSv3.1.

Example:

{
"scoringSystem": "CVSSv3.1"
}

isOnHold (string) (optional)

Whether project is currently On-Hold. Must be either Yes or No.

Example:

{
"isOnHold": "Yes"
}

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:

{
"isOnHoldReason": "The environment is currently experiencing issues and is not working."
}

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.

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 '{
"id": "5e6881d12fdbcd0a5af71e8c",
"name": "ACME Digital Web App Pentest",
"code": "DEMO9999",
"groups": ["ACME Corp Digital Team"],
"startDate": "2020-01-05",
"endDate": "2020-01-10",
"scoringSystem": "CVSSv3.1",
"isOnHold": "Yes",
"isOnHoldReason": "The environment is currently experiencing issues and is not working."
}'

Response

Response contains a project object.

{
"project": {
"id": "...",
"created": "...",
"last_updated": "...",
"name": "...",
"code": "...",
"groups": ["...", "...", "..."],
"startDate": "...",
"endDate": "...",
"scoring_system": "...",
"isOnHold": "..."
}
}