Get Site Scans

External DocumentationTo learn more, visit the Rapid7 documentation.

Basic Parameters

Parameter	Description
Active	Return running scans or past scans. True for running scans and false for past scans.
Disable SSL Enforcement	Enable this option to skip SSL verification of the server’s certificate chain and host name. This may increase security vulnerabilities, but can be useful for testing or when custom verification is employed.
Return All Pages	Automatically fetch all resources, page by page.
Site ID	The ID of the site.

Advanced Parameters

Parameter	Description
Page	The index of the page (zero-based) to retrieve.
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": "",
			"startTime": "",
			"startedBy": "",
			"status": "",
			"vulnerabilities": {
				"critical": 16,
				"moderate": 3,
				"severe": 76,
				"total": 95
			}
		}
	]
}

Integrations

Basic Parameters

Advanced Parameters

Example Output

Workflow Library Example

​Basic Parameters

​Advanced Parameters

​Example Output

​Workflow Library Example

Basic Parameters

Advanced Parameters

Example Output

Workflow Library Example