AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetVulnerabilities
This method can be used for the following functionality: Get details for all vulnerabilities this user has access to. 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/vulnerabilities HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

startDate (string) (optional)
Start date to query vulnerabilities from, based on creation date. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/vulnerabilities?startDate=2020-01-01 HTTP/1.1
Copied!
endDate (string) (optional)
End date to query vulnerabilities to, based on creation date. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/vulnerabilities?endDate=2020-12-31 HTTP/1.1
Copied!
priority (string) (optional)
Priority for vulnerabilities returned. Must be one of the following: Critical, High, Medium, Low, Info
Example:
1
GET /api/ss/vulnerabilities?priority=Critical HTTP/1.1
Copied!
skip (integer) (optional)
Number of records to skip. Default is 0 (do not skip any records).
Example:
1
GET /api/ss/vulnerabilities?skip=10 HTTP/1.1
Copied!
limit (integer) (optional)
Number of records to limit to. Default limit is 500. Max limit is 500.
Example:
1
GET /api/ss/vulnerabilities?limit=100 HTTP/1.1
Copied!

Example

The following example is a cURL request to get all Critical vulnerabilities between 1st January 2020 to 31st December 2020.

Request

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

Response

Response contains an array of vulnerability objects.
1
{
2
"count": 999,
3
"vulnerabilities":[
4
{
5
"vulnerability_id": "...",
6
"vulnerability_alternate_id": "...",
7
"vulnerability_created": "...",
8
"vulnerability_modified": "...",
9
"vulnerability_title": "...",
10
"vulnerability_priority": "...",
11
"vulnerability_cvssv3_vector": "...",
12
"vulnerability_cvssv3_base_score": "...",
13
"vulnerability_cvssv3_temporal_score": "…",
14
"vulnerability_cvssv3_environmental_score": "...",
15
"vulnerability_status": "...",
16
"vulnerability_status_updated": "...",
17
"vulnerability_retest": "...",
18
"vulnerability_likelihood_of_exploitation": 10,
19
"vulnerability_steps_to_reproduce": "...",
20
"vulnerability_steps_to_reproduce_HTML": "...",
21
"vulnerability_tags": ["...","..."],
22
"vulnerability_is_zeroday": "...",
23
"vulnerability_notes": [{"note":"..."},{"note":"..."}],
24
"vulnerability_description": "...",
25
"vulnerability_attack_scenario": "...",
26
"vulnerability_remediation_recommendation": "...",
27
"vulnerability_remediation_notes": [{"note":"...","created":"...","created_by":"..."}],
28
"vulnerability_affected_asset_name": "...",
29
"vulnerability_affected_asset_id": "...",
30
"vulnerability_affected_asset_library_id": "...",
31
"vulnerability_affected_asset_library_external_id": "...",
32
"vulnerability_project_name": "...",
33
"vulnerability_project_id": "...",
34
"vulnerability_project_code": "...",
35
"vulnerability_project_groups": [{"id": "...", "name": "..."}],
36
"vulnerability_discovered_by": "...",
37
"vulnerability_evidence": [{"file_name":"...","file_name_custom":"...","storage_name":"...","file_type":"...","file_size_kb":"..."}],
38
"vulnerability_custom_fields": [{"key": "...", "value": "...", "type": "Tag/Field"}],
39
"vulnerability_library_custom_fields": [{"key": "...", "value": "...", "type": "Tag/Field"}],
40
"vulnerability_project_custom_fields": [{"key": "...", "value": "...", "type": "Tag/Field"}]
41
}
42
]
43
}
Copied!
Last modified 12d ago