Skip to main content

Scan Profiles

A scan profile is associated with a target and determines how Snyk API & Web scans that target.

There is a set of built-in scan profiles provided by Snyk API & Web that already address the most common types of scans. However, it is also possible to create custom scan profiles to adjust and fine-tune scans for specific needs.

Functionality​

The endpoints under Scan Profiles provide the following functionality:

  • List and retrieve scan profiles (built-in and custom).
  • Create and change custom scan profiles.

Important Notes​

Some relevant information when using Scan Profiles:

  • Only custom scan profiles can be created or changed.
  • If a custom scan profile is no longer in use, mark it as inactive.

Further functionality related to Scan Profiles is provided in the following tags:

  • Targets - Associate scan profiles to targets.