v1/scan/scans

This API endpoint retrieves a list of scan results, including details such as the target address, scan status, and vulnerability counts.

Request URL

curl -X GET "https://api.securitysurface.com/v1/scan/scans?c=0&l=100" \
-H "apikey: your_api_key" \
-H "Content-Type: application/json"

Replace your_api_key with your actual API key.

Request Parameters

Parameter Type Location Required Description
c int query Yes The starting index for pagination, defaults to 0.
l int query Yes The number of scan results to return.

Response Data 


    {
    "pagination": {
        "total": 2272,
        "cur": 0,
        "next": 100
    },
    "scans": [
        {
            "address": "example.com",
            "tag": "-",
            "profile": "Crawl Only",
            "start_date": "2024/10/29 5:24:57",
            "progress": 0,
            "status": "aborted",
            "scan_id": "dc47a28f-7175-4895-b132-e091cacdbe18",
            "vuln_counts": {
                "critical": 0,
                "high": 0,
                "medium": 0,
                "low": 0,
                "info": 0
            }
        },
        {
            "address": "43.201.*.*",
            "tag": "43.201.*.*",
            "profile": "Critical / High / Medium Risk",
            "start_date": "2024/9/11 10:38:37",
            "progress": 0,
            "status": "failed",
            "scan_id": "dcccedd5-d9a5-4807-99e8-303abf8ce0b0",
            "vuln_counts": {
                "critical": 0,
                "high": 11,
                "medium": 4,
                "low": 0,
                "info": 5
            }
        }
    ]
}