AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetProjects
This method can be used for the following functionality: Get details for all projects this user has access to. with optional filter. This method can be used with optional filter.

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
GET /api/ss/projects 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) (optional)
Name of the project.
Example:
1
GET /api/ss/projects?name=Test Project HTTP/1.1
Copied!
code (string) (optional)
Project code.
Example:
1
GET /api/ss/projects?code=Project123 HTTP/1.1
Copied!
status (string) (optional)
Status of the project. Must be one of the following: Waiting-to-Start, Testing, Completed, On-Hold
Example:
1
GET /api/ss/projects?status=Testing HTTP/1.1
Copied!
startDate (string) (optional)
Start date to query projects from. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/projects?startDate=2020-01-01 HTTP/1.1
Copied!
endDate (string) (optional)
End date to query projects to. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/projects?endDate=2020-12-31 HTTP/1.1
Copied!

Example

The following example is a cURL request to get all projects with status 'Testing' which have a test window between 1st January 2020 to 1st February 2020.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X GET 'https://demo.attackforge.com/api/ss/projects?startDate=2020-01-01&endDate=2020-02-01&status=Testing' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

Response contains an array of project objects.
1
{
2
"count": 999,
3
"projects":[
4
{
5
"project_id": "...",
6
"project_name": "...",
7
"project_code": "...",
8
"project_organization_code": "...",
9
"project_vulnerability_code": "..."
10
"project_groups": [{"name":"...", "id":"..."}],
11
"project_status": "...",
12
"project_on_hold": "...",
13
"project_start_date": "...",
14
"project_end_date": "...",
15
"project_scope": ["..."],
16
"project_scoring": "...",
17
"project_team_notifications": ["..."],
18
"project_admin_notifications": ["..."],
19
"project_total_assets": 999,
20
"project_total_testcases": 999,
21
"project_not_tested_testcases": 999,
22
"project_in_progress_testcases": 999,
23
"project_tested_testcases": 999,
24
"project_not_applicable_testcases": 999,
25
"project_total_vulnerabilities": 999,
26
"project_open_vulnerabilities": 999,
27
"project_closed_vulnerabilities": 999,
28
"project_retest_vulnerabilities": 999,
29
"project_critical_vulnerabilities": 999,
30
"project_critical_open_vulnerabilities": 999,
31
"project_critical_ready_for_retest_vulnerabilities": 999,
32
"project_critical_closed_vulnerabilities": 999,
33
"project_high_vulnerabilities": 999,
34
"project_high_open_vulnerabilities": 999,
35
"project_high_ready_for_retest_vulnerabilities": 999,
36
"project_high_closed_vulnerabilities": 999,
37
"project_medium_vulnerabilities": 999,
38
"project_medium_open_vulnerabilities": 999,
39
"project_medium_ready_for_retest_vulnerabilities": 999,
40
"project_medium_closed_vulnerabilities": 999,
41
"project_low_vulnerabilities": 999,
42
"project_low_open_vulnerabilities": 999,
43
"project_low_ready_for_retest_vulnerabilities": 999,
44
"project_low_closed_vulnerabilities": 999,
45
"project_info_vulnerabilities": 999,
46
"project_info_open_vulnerabilities": 999,
47
"project_info_ready_for_retest_vulnerabilities": 999,
48
"project_info_closed_vulnerabilities": 999,
49
"project_zeroday_vulnerabilities": 999,
50
"project_easily_exploitable_vulnerabilities": 999,
51
"project_cwe_top_25_vulnerabilities": 999,
52
"project_owasp_top_10_vulnerabilities": 999,
53
"project_pending_vulnerabilities": 999,
54
"project_retests_requested": 999,
55
"project_retests_completed": 999,
56
"project_created": "...",
57
"project_last_modified": "...",
58
"project_custom_fields": [{"key": "...", "value": "...", "type": "Tag/Field"}]
59
}
60
]
61
}
Copied!
Last modified 12d ago