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

Special Note

Assets are ordered by priority rating: i.e. Critical, then High, then Medium, then Low, then Informational.

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/analytics/vulnerable/assets HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

limit (integer) (optional)
Limit how many assets to return. Must be an integer e.g. 10.
Example:
1
GET /api/ss/analytics/vulnerable/assets?limit=10 HTTP/1.1
Copied!
startDate (string) (optional)
Start date to query vulnerabilities from. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/analytics/vulnerable/assets?startDate=2020-01-01 HTTP/1.1
Copied!
endDate (string) (optional)
End date to query vulnerabilities to. String in YYYY-MM-DD format.
Example:
1
GET /api/ss/analytics/vulnerable/assets?endDate=2020-12-31 HTTP/1.1
Copied!

Example

The following example is a cURL request to get Top 10 most vulnerable assets 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/analytics/vulnerable/assets?limit=10&startDate=2020-01-01&endDate=2020-02-01' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

Response contains an array of asset objects.
1
{
2
"count": 999,
3
"assets":[
4
{
5
"asset": "...",
6
"critical_vulnerabilities": 999,
7
"high_vulnerabilities": 999,
8
"medium_vulnerabilities": 999,
9
"low_vulnerabilities": 999,
10
"informational_vulnerabilities": 999
11
}
12
]
13
}
Copied!
Last modified 1yr ago