Get Scans

Returns all scans.

External Documentation

To learn more, visit the Rapid7 documentation.

Parameters

Parameter	Description
Active	Return running scans or past scans (true/false value).
Disable SSL Enforcement	Enable this option to skip SSL verification of the server's certificatechain and host name. This may increase security vulnerabilities, but can be usefulfor testing or when custom verification is employed.
Page	The index of the page (zero-based) to retrieve.
Return All Pages	Automatically fetch all resources, page by page.
Size	The number of records per page to retrieve.
Sort	The criteria to sort the records by, in the format: property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Example Output

{
    "links": [
        {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
        }
    ],
    "page": {
        "number": 6,
        "size": 10,
        "totalPages": 13,
        "totalResources": 123
    },
    "resources": [
        {
            "assets": 0,
            "duration": "",
            "endTime": "",
            "engineId": 0,
            "engineName": "",
            "id": 0,
            "links": [
                {
                    "href": "https://hostname:3780/api/3/...",
                    "rel": "self"
                }
            ],
            "message": "",
            "scanName": "",
            "scanType": "",
            "siteId": 0,
            "siteName": "string",
            "startTime": "",
            "startedBy": "",
            "status": "",
            "vulnerabilities": {
                "critical": 16,
                "moderate": 3,
                "severe": 76,
                "total": 95
            }
        }
    ]
}

Workflow Library Example

Get Scans with Rapid7 and Send Results Via Email

Preview this Workflow on desktop