Get Scans

Retrieves a page of scans.

External Documentation

To learn more, visit the Rapid7 InsightVM Cloud documentation.

​

Parameters

Parameter	Description
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.

​

Example Output

{
	"description": "A page of scans.",
	"summary": "Example",
	"value": {
		"data": [
			{
				"engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
				"finished": "2020-05-12T09:08:54.404Z",
				"id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
				"name": "Scan API Example Name",
				"started": "2020-05-12T09:00:12.199Z",
				"status": "Success"
			}
		],
		"links": [
			{
				"href": "https://{region}.api.insight.rapid7.com:443/vm/v4/integration/scan?page=0\u0026size=10",
				"rel": "self"
			}
		],
		"metadata": {
			"number": 0,
			"size": 10,
			"totalPages": 1,
			"totalResources": 1
		}
	}
}