v1/scan/overview

This API provides an overview of the scan operations, including the total number of scans, the status of current scans, and vulnerability counts.

Request URL

curl -i -X GET "https://api.securitysurface.com/v1/scan/overview" \
-H "apikey: your_api_key" \
-H "Content-Type: application/json"

Replace your_api_key with your actual API key.

Request Parameters

None

Response Data 

{
    "status": "ss_success",
    "scans_completed_count": 7,
    "scans_running_count": 0,
    "scans_waiting_count": 0,
    "scans_total_count": 17,
    "vuln_count": {
        "crit": 0,
        "high": 95,
        "med": 35,
        "low": 15
    },
    "vuln_total_count": 145
}