AttackForge Enterprise & AttackForge Core
Powered By GitBook
CreateProject
This method can be used for the following functionality: Create a new Project in AttackForge

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
POST /api/ss/project HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

name (string)
Name of the project.
Example:
1
{
2
"name": "..."
3
}
Copied!
code (string)
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)
Project start date. String in YYYY-MM-DD format.
Example:
1
{
2
"startDate": "2020-01-01"
3
}
Copied!
endDate (string)
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!
scope (array of strings)
Project scope / assets to be tested.
Example:
1
{
2
"scope": ["...", "...", "..."]
3
}
Copied!
testsuites (array of strings)
Testsuites to assign to the project. Must match exact testsuite names.
Example:
1
{
2
"testsuites": ["...", "...", "..."]
3
}
Copied!

Example

The following example is a cURL request to create a new project.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X POST 'https://demo.attackforge.com/api/ss/project' -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
"startDate": "2020-01-01",
6
"endDate": "2020-01-05",
7
"scoringSystem": "CVSSv3.1",
8
"scope": ["test.com", "192.168.0.1"],
9
"testsuites": ["ASVS Level 2 Web Application", "OSSTMM v3.0 Infrastructure"]
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 11mo ago