Start Scan
Starts a scan for the specified site.
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. |
Scan Name | The user-driven scan name for the scan. |
Site ID | The ID of the site. |
Advanced Parameters
Parameter | Description |
---|---|
Engine ID | The ID of the scan engine. |
Hosts | A comma-separated list of the hosts that should be included as a part of the scan. This should be a mixture of IP Addresses and Hostnames as a String array. |
Template ID | The ID of the scan template. |
Example Output
{
"id": 1,
"links": [
{
"href": "https://hostname:3780/api/3/...",
"rel": "self"
}
]
}
Workflow Library Example
Start Scan with Rapid7 and Send Results Via Email