AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetVulnerabilityLibraryIssues
This method can be used for the following functionality: Get details for all vulnerabilities in the library. 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/library 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 vulnerability.
Example:
1
GET /api/ss/library?name=SQL%20Injection HTTP/1.1
Copied!
reference_id (string) (optional)
Reference Id of the vulnerability in the library (15-digit number).
Example:
1
GET /api/ss/library?reference_id=754483619065784 HTTP/1.1
Copied!
created_from (string) (optional)
Start date to query vulnerabilities from, based on creation date. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/library?created_from=2020-01-01 HTTP/1.1
Copied!
created_to (string) (optional)
End date to query vulnerabilities to, based on creation date. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/library?created_to=2020-12-31 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/library?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/library?limit=100 HTTP/1.1
Copied!

Example

The following example is a cURL request to get all SQL Injection vulnerabilities in the library created between 1st January 2018 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/library?created_from=2018-01-01&created_to=2020-12-31&name=SQL%20Injection' -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
"created": "...",
6
"last_modified": "...",
7
"reference_id": "...",
8
"category": "...",
9
"title": "...",
10
"description": "...",
11
"severity": "10",
12
"likelihood_of_exploitation": "10",
13
"priority": "Critical",
14
"attack_scenario": "...",
15
"remediation_recommendation": "...",
16
"impact_on_confidentiality": "High",
17
"impact_on_integrity": "Medium",
18
"impact_on_availability": "Low",
19
"tags": ["...", "..."],
20
"id": "...",
21
"created_by": "...",
22
"belongs_to_library": "Imported Vulnerabilities",
23
"import_source": "...",
24
"import_source_id": "...",
25
"custom_fields": [{"key": "...", "value": "...", "type": "Tag/Field"}]
26
}
27
]
28
}
Copied!
Last modified 12d ago