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/analytics/common/vulnerabilities HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

limit (integer) (optional)

Limit how many vulnerabilities to return. Must be an integer e.g. 10.

Example:

GET /api/ss/analytics/common/vulnerabilities?limit=10 HTTP/1.1

startDate (string) (optional)

Start date to query vulnerabilities from. String in YYYY-MM-DD format.

Example:

GET /api/ss/analytics/common/vulnerabilities?startDate=2020-01-01 HTTP/1.1

endDate (string) (optional)

End date to query vulnerabilities to. String in YYYY-MM-DD format.

Example:

GET /api/ss/analytics/common/vulnerabilities?endDate=2020-12-31 HTTP/1.1

Example

The following example is a cURL request to get Top 10 most common vulnerabilities between 1st January 2020 to 1st February 2020.

Request

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

curl -X GET 'https://demo.attackforge.com/api/ss/analytics/common/vulnerabilities?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'

Response

Response contains an array of vulnerability objects.

{
   "count": 999,
   "vulnerabilities":[
      {
         "name": "..."
         "count": 999
      }
   ]
}