External DocumentationTo learn more, visit the Rapid7 documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Disabled Category Checks | The categories of vulnerability checks to disable during a scan. |
| Disabled Individual Checks | The individual vulnerability checks to disable during a scan. |
| Disabled Type Checks | The types of vulnerability checks to disable during a scan. |
| Enabled Category Checks | The categories of vulnerability checks to enable during a scan. |
| Enabled Individual Checks | The individual vulnerability checks to enable during a scan. |
| Enabled Type Checks | The types of vulnerability checks to enable during a scan. |
| Scan Template Description | A verbose description of the scan template. |
| Scan Template Name | A concise name for the scan template. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Correlate | Whether an extra step is performed at the end of the scan where more trust is put in OS patch checks to attempt to override the results of other checks which could be less reliable. |
| 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. |
| Enable Windows Services | Whether Windows services are enabled during a scan. Windows services will be temporarily reconfigured when this option is selected. Original settings will be restored after the scan completes, unless it is interrupted. |
| Enhanced Logging | Whether enhanced logging is gathered during scanning. Collection of enhanced logs may greatly increase the disk space used by a scan. |
| Max Parallel Assets | The maximum number of assets scanned simultaneously per scan engine during a scan. |
| Max Scan Processes | The maximum number of scan processes simultaneously allowed against each asset during a scan. |
| Policy Enabled | Whether policy assessment is performed during a scan. |
| Potential Checks | Whether checks that result in potential vulnerabilities are assessed during a scan. |
| Unsafe Checks | Whether checks considered “unsafe” are assessed during a scan. |
| Vulnerability Enabled | Whether vulnerability assessment is performed during a scan. |
| Web Enabled | Whether web spidering and assessment are performed during a scan. |
Example Output
{
"id": "1",
"links": [
{
"href": "https://hostname:3780/api/3/...",
"rel": "self"
}
]
}
Workflow Library Example
Create Scan Template with Rapid7 and Send Results Via Email