Scans
A scan identifies security vulnerabilities in a target through three core components, each one with a specific job:
- Fingerprinter - Identifies the technologies used on the target, which help further identify vulnerabilities and improve Snyk API & Web's suggestions on how to fix them.
- Crawler - Goes through the target's URLs and interacts with every element found, clicking on buttons and filling in forms, among other actions.
- Scanner - Finds vulnerabilities in the target's URLs provided by the Crawler, also improved by the technologies identified by the Fingerprinter.
The scope of the scan is determined by the target, as well as the behavior of the scan, such as authentication options, extra hosts, scanning profiles, and others. While scanning, vulnerabilities identified by the scanner produce findings that become associated with the target.
Learn more about scans in What happens during a scan?
Functionality
The endpoints under Scans provide the following functionality:
-
Account Level
- List scans of all account targets.
- Start, pause, resume, or cancel scans in bulk for account targets.
-
Target Level
- Retrieve the scan currently executing on a target.
- Pause, resume, or cancel the scan currently executing on a target.
- List all scans of a target.
- Retrieve and update a scan of a target.
- Pause, resume, or cancel a scan of a target.
- Export the list of endpoints covered by a scan of a target.
Related Tags
Further functionality related to Scans is provided in the following tags:
- Targets - Manage the scope and behavior of target scans, which extend also to other tags, namely:
- Extra Hosts - Manage extra hosts to extend the scope of target scans to more domains.
- Scanning Agent - Manage scanning agents to extend the scope of target scans to internal applications.
- Reduced Scope - Manage reduced scopes to run partial scans on a subset of the target.
- Navigation and Login Sequences - Manage recorded sequences of browser interactions to replay in target scans.
- Scan Profiles - Manage scan profiles to configure how target scans are performed.
- Scheduled Scans - Manage scheduled target scans.
- Findings - Manage vulnerabilities identified in the scans.
- Reports - Retrieve reports on findings from scans.
List Account's Scans
Retrieve Account's Scans
Bulk Cancel Scans
Bulk Pause Scans
Bulk Resume Scans
Bulk Start Scans
List Scan Warnings
Retrive Scan Warning
Start a scan
Retrieve Target's Current Scan
Cancel Target's Current Scan
Pause Target's Current Scan
Resume Target's Current Scan
List Target's Scans
Retrieve Scan
Update Scan
Partial Update Scan
Cancel Scan
Count Scan Endpoints
Every coverage count in one call, over the scan's whole coverage: the total, and the endpoints per category, status code group, HTTP method and authentication state. Each count equals what the matching endpoints filter selects.
Count Scan Endpoints By Reason
The endpoints per reason, over the scan's whole coverage. Separate from the other counts because reason is the one expensive column to group on. Each count equals what the `reason` filter selects for that value.
List Scan Endpoints
Returns discovered endpoints in JSON (paginated) or CSV format depending on the Accept header. Default format is CSV for backward compatibility. With the target's All URLs report setting enabled, skipped URLs and their reasons are included for 90 days.
Retrieve Endpoint Detail
Returns detailed information about a specific endpoint including the parsed and obfuscated HTTP request.
List Scan Hosts
Every distinct origin (scheme, host and non-default port) in the scan's coverage, each with a count of matching endpoints — the Host filter's own options. The same host crawled over both http and https, or on two ports, appears as separate entries.