AttackForge Enterprise & AttackForge Core
Powered By GitBook
UpdateProjectRequestById
This method can be used for the following functionality: Update a project request that you have access to, by project request identifier (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/request/: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)
Identifier for the project request.
Example:
1
PUT /api/ss/request/5e8017d2e1385f0c58e8f4f8 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!
scope (array of strings) (optional)
Project scope / assets to be tested.
Example:
1
{
2
"scope": ["...", "...", "..."]
3
}
Copied!
testsuites (array of strings) (optional)
Testsuites to assign to the project. Must match exact testsuite names.
Example:
1
{
2
"testsuites": ["...", "...", "..."]
3
}
Copied!
startDate (string) (optional)
Desired project start date. String in YYYY-MM-DD format.
Example:
1
{
2
"startDate": "2020-01-01"
3
}
Copied!
endDate (string) (optional)
Desired project end date. String in YYYY-MM-DD format.
Example:
1
{
2
"endDate": "2020-01-05"
3
}
Copied!
test_window (array of strings) (optional)
Test window for the project. Must be one or more of the following: Weekdays-BusinessHours, Weekdays-NonBusinessHours, Weekends
Example:
1
{
2
"test_window": ["Weekdays-BusinessHours", "Weekends"]
3
}
Copied!
onsite_testing (string) (optional)
Whether onsite testing is required or not. Must be one or more of the following: Yes, No
Example:
1
{
2
"onsite_testing": "Yes"
3
}
Copied!

Example

The following example is a cURL request to update a project request.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X PUT 'https://demo.attackforge.com/api/ss/request/5e8017d2e1385f0c58e8f4f8' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
2
"name": "ACME Corp Web App Pentest",
3
"code": "DEMO9999",
4
"groups": ["ACME Corp Digital Team", "Pentest Team"],
5
"scope": ["test.com", "192.168.0.1"],
6
"testsuites": ["ASVS Level 2 Web Application", "OSSTMM v3.0 Infrastructure"],
7
"startDate": "2020-01-01",
8
"endDate": "2020-01-05",
9
"test_window": ["Weekdays-BusinessHours", "Weekends"],
10
"onsite_testing": "Yes"
11
}'
Copied!

Response

Response contains a result object.
1
{
2
"result": {
3
"result": "Project Request Updated"
4
}
5
}
Copied!
Last modified 1yr ago