AttackForge Enterprise

GetVulnerabilitiesByGroup

This method can be used for the following functionality: Get details for all vulnerabilities for a group that you are a member of. 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

GET /api/ss/groups/:id/vulnerabilities HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Identifier for the group.

Example:

GET /api/ss/groups/5e6880f33e6d520a26fef4b0/vulnerabilities HTTP/1.1

startDate (string) (optional)

Start date to query vulnerabilities from, based on creation date. String in YYYY-MM-DD format.

Example:

GET /api/ss/groups/:id/vulnerabilities?startDate=2020-01-01 HTTP/1.1

endDate (string) (optional)

End date to query vulnerabilities to, based on creation date. String in YYYY-MM-DD format.

Example:

GET /api/ss/groups/:id/vulnerabilities?endDate=2020-12-31 HTTP/1.1

priority (string) (optional)

Priority for vulnerabilities returned. Must be one of the following: Critical, High, Medium, Low, Info

Example:

GET /api/ss/groups/:id/vulnerabilities?priority=Critical HTTP/1.1

Example

The following example is a cURL request to get all Critical vulnerabilities between 1st January 2020 to 31st December 2020 for projects which belong to the group.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X GET 'https://demo.attackforge.com/api/ss/groups/5e6880f33e6d520a26fef4b0/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'

Response

Response contains an array of vulnerability objects.

{
"count": 999,
"vulnerabilities":[
{
"vulnerability_id": "...",
"vulnerability_created": "...",
"vulnerability_modified": "...",
"vulnerability_title": "...",
"vulnerability_priority": "...",
"vulnerability_status": "...",
"vulnerability_status_updated": "...",
"vulnerability_retest": "...",
"vulnerability_likelihood_of_exploitation": 10,
"vulnerability_steps_to_reproduce": "...",
"vulnerability_tags": ["...","..."],
"vulnerability_is_zeroday": "...",
"vulnerability_notes": [{"note":"..."},{"note":"..."}],
"vulnerability_description": "...",
"vulnerability_attack_scenario": "...",
"vulnerability_remediation_recommendation": "...",
"vulnerability_affected_asset_name": "...",
"vulnerability_affected_asset_id": "...",
"vulnerability_affected_asset_library_id": "...",
"vulnerability_affected_asset_library_external_id": "...",
"vulnerability_project_name": "...",
"vulnerability_project_id": "...",
"vulnerability_discovered_by": "..."
}
]
}