AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetProjectById
This method can be used for the following functionality: Get details for a project user has access to, by project 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
GET /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)
Identifier for the project.
Example:
1
GET /api/ss/project/5e48c12ec0376309d73aad71 HTTP/1.1
Copied!

Example

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

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X GET 'https://demo.attackforge.com/api/ss/project/5e48c12ec0376309d73aad71' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

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