Skip to main content

Create Scan Template

Creates a new scan template.

External Documentation

To learn more, visit the Rapid7 documentation.

Basic Parameters​

ParameterDescription
Disabled Category ChecksThe categories of vulnerability checks to disable during a scan.
Disabled Individual ChecksThe individual vulnerability checks to disable during a scan.
Disabled Type ChecksThe types of vulnerability checks to disable during a scan.
Enabled Category ChecksThe categories of vulnerability checks to enable during a scan.
Enabled Individual ChecksThe individual vulnerability checks to enable during a scan.
Enabled Type ChecksThe types of vulnerability checks to enable during a scan.
Scan Template DescriptionA verbose description of the scan template..
Scan Template NameA concise name for the scan template.

Advanced Parameters​

ParameterDescription
CorrelateWhether 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 EnforcementEnable this option to skip SSL verification of the server's certificatechain and host name. This may increase security vulnerabilities, but can be usefulfor testing or when custom verification is employed.
Enable Windows ServicesWhether 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 LoggingWhether enhanced logging is gathered during scanning. Collection of enhanced logs may greatly increase the disk space used by a scan.
Max Parallel AssetsThe maximum number of assets scanned simultaneously per scan engine during a scan.
Max Scan ProcessesThe maximum number of scan processes simultaneously allowed against each asset during a scan.
Policy EnabledWhether policy assessment is performed during a scan.
Potential ChecksWhether checks that result in potential vulnerabilities are assessed during a scan.
Unsafe ChecksWhether checks considered "unsafe" are assessed during a scan.
Vulnerability EnabledWhether vulnerability assessment is performed during a scan.
Web EnabledWhether 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

Workflow LibraryPreview this Workflow on desktop