Get Assets

Returns the inventory, assessment, and summary details for a page of assets. Only assets which the caller has access to are returned.

External Documentation

To learn more, visit the Rapid7 InsightVM Cloud documentation.

Parameters

Parameter	Description
Assets Filter Query	Filters assets using InsightVM Cloud query language. Refer to the InsightVM Cloud documentation for more details on building InsightVM Cloud queries.
Page	The number of page to return.
Page Size	The size of page to return.
Property To Sort By	The property to sort the results by.
Return All Pages	Automatically fetch all resources, page by page.
Sort Method	The order in which results will be returned.
Vulnerabilities Filter Query	Filters vulnerabilities using InsightVM Cloud query language. Refer to the InsightVM Cloud documentation for more details on building InsightVM Cloud queries.

Example Output

{
    "data": [
        {
            "assessed_for_policies": false,
            "assessed_for_vulnerabilities": true,
            "critical_vulnerabilities": 0,
            "exploits": 0,
            "id": "452534235-25a7-40a3-9321-28ce0b5cc90e-default-asset-199",
            "ip": "10.1.0.128",
            "last_assessed_for_vulnerabilities": "2020-03-20T19:19:42.611Z",
            "last_scan_end": "2020-03-20T19:19:42.611Z",
            "last_scan_start": "2020-03-20T19:18:13.611Z",
            "malware_kits": 0,
            "moderate_vulnerabilities": 2,
            "os_architecture": "x86_64",
            "os_description": "CentOS Linux 2.6.18",
            "os_family": "Linux",
            "os_name": "Linux",
            "os_system_name": "CentOS Linux",
            "os_type": "General",
            "os_vendor": "CentOS",
            "os_version": "2.6.18",
            "risk_score": 0,
            "severe_vulnerabilities": 0,
            "tags": [
                {
                    "name": "lab",
                    "type": "SITE"
                }
            ],
            "total_vulnerabilities": 2,
            "new": [],
            "remediated": []
        },
        {
            "assessed_for_policies": false,
            "assessed_for_vulnerabilities": true,
            "critical_vulnerabilities": 1,
            "exploits": 9,
            "host_name": "host.domain.com",
            "id": "452534235-25a7-40a3-9321-28ce0b5cc90e-default-asset-198",
            "ip": "10.4.24.164",
            "last_scan_end": "2020-03-20T19:12:39.766Z",
            "last_scan_start": "2020-03-20T19:05:06.766Z",
            "malware_kits": 0,
            "moderate_vulnerabilities": 11,
            "os_architecture": "",
            "os_description": "Ubuntu Linux 12.04",
            "os_family": "Linux",
            "os_name": "Linux",
            "os_system_name": "Ubuntu Linux",
            "os_type": "",
            "os_vendor": "Ubuntu",
            "os_version": "12.04",
            "risk_score": 12251.76171875,
            "severe_vulnerabilities": 16,
            "tags": [
                {
                    "name": "all_assets2",
                    "type": "CUSTOM"
                },
                {
                    "name": "all_assets",
                    "type": "CUSTOM"
                },
                {
                    "name": "Linux",
                    "type": "CUSTOM"
                },
                {
                    "name": "docker hosts",
                    "type": "SITE"
                },
                {
                    "name": "lab",
                    "type": "SITE"
                }
            ],
            "total_vulnerabilities": 28,
            "new": [],
            "remediated": [],
            "unique_identifiers": {
                "id": "4421d73dfe04f594df731e6bcd8156a",
                "source": "R7 Agent"
            }
        }
    ],
    "metadata": {
        "number": 0,
        "size": 2,
        "totalResources": 2195,
        "totalPages": 1098,
        "cursor": "1542252837:::_S:::12474375-34a7-40a3-9821-28db0b5cc90e-default-asset-10"
    },
    "links": [
        {
            "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=0&size=2",
            "rel": "first"
        },
        {
            "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=0&size=2",
            "rel": "self"
        },
        {
            "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=1&size=2&cursor=1542252837:::_S:::12474375-34a7-40a3-9821-28db0b5cc90e-default-asset-10",
            "rel": "next"
        },
        {
            "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=1097&size=2",
            "rel": "last"
        }
    ]
}

Workflow Library Example

Get Assets with Rapid7 Insightvm Cloud and Send Results Via Email

Preview this Workflow on desktop