Get Asset Groups
Returns all asset groups.
External Documentation
To learn more, visit the Rapid7 documentation.
Basic Parameters
Parameter | Description |
---|---|
Disable SSL | 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. |
Name | A search pattern for the name of the asset group. Searches are case-insensitive contains. |
Return All Pages | Automatically fetch all resources, page by page. |
Type | The type of asset group. |
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 |
Example Output
{
"links": [
{
"href": "https://hostname:3780/api/3/...",
"rel": "self"
}
],
"page": {
"number": 6,
"size": 10,
"totalPages": 13,
"totalResources": 123
},
"resources": [
{
"assets": 768,
"description": "Assets with unacceptable high risk required immediate remediation.",
"id": 61,
"links": [
{
"href": "https://hostname:3780/api/3/...",
"rel": "self"
}
],
"name": "High Risk Assets",
"riskScore": 4457823.78,
"searchCriteria": {
"filters": [
{
"field": "",
"lower": "",
"operator": "",
"upper": "",
"value": "",
"values": [
"string"
]
}
],
"match": "all"
},
"type": "dynamic",
"vulnerabilities": {
"critical": 16,
"moderate": 3,
"severe": 76,
"total": 95
}
}
]
}
Workflow Library Example
Get Asset Groups with Rapid7 and Send Results Via Email