Skip to main content

Targets

In Snyk API & Web, a target defines the scope and behavior of a scan on a website, an application, or an API.
Each target has a URL that defines the scope of the scan and also the configuration of the scan behavior as, for example:

  • The authentication mechanism for the scanner to be able to log in.
  • The scan profile defining how the scan is performed.
  • The integration with third-party systems, like Jira, to synchronize scan results.

Learn more about targets in this article: Targets from A to Z.

Functionality​

The endpoints under Targets provide the following functionality:

  • Create and manage targets.
  • Update and delete targets in bulk.
  • Export and import targets.
  • Upload and download API schema files of API targets.
  • Check authentication in API targets.
  • Clear authentication configurations in targets.
  • Create and manage logout detectors in targets.

Further functionality related to Targets is provided in the following tags:

  • Target Scans Configuration
    • Extra Hosts - Manage extra hosts to extend the scope of target scans to more domains.
    • Scanning Agents - 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.
  • Target Scans
  • Findings
    • Findings - Manage findings obtained from target scans.
  • Reports
    • Reports - Retrieve reports on findings from target scans.
    • Dashboards - Retrieve statistical information on target scans.
  • Integrations
    • Slack Integration - Manage the integration with Slack to get notifications of events on target scans.
    • Jira Cloud Integration - Manage the integration with Jira to synchronize findings from target scans.
    • Reports - Delete reports from Jira.
    • Azure DevOps Integration - Manage the integration with Azure DevOps to synchronize findings from target scans.
  • Events
    • Events - Manage notifications of events on targets and target scans.
  • Target Management
    • Account - Manage targets with unlimited scans in the account.
    • Teams - Manage targets in teams.
    • Target Labels - Manage labels to apply to targets to facilitate target management.

📄️Disable Active API Authentication Method

Disables the currently active API authentication method and, when another method is ready on the same row, switches to it so the target stays authenticated. Since BAW-2131 the stored credentials of the deactivated method (payload SA fields or browser-auth token descriptors) are preserved so the caller can toggle the active method back via a PUT of `api_login_method` without re-entering them. Callers that want to truly clear a method's stored configuration should PATCH the api-scan-settings endpoint with empty strings.

📄️List Collection Variable References

Return the sorted, de-duplicated list of variable names the target's Postman or Bruno collection *reads* — from ``{{placeholder}}`` references in URLs, headers, bodies and auth blocks, and from ``pm.environment.get('name')`` / ``bru.getVar('name')`` / ``bru.getEnvVar('name')`` calls in pre-request and test scripts. Setter calls are intentionally excluded; globals-scope getters (``pm.globals.get`` / ``bru.getGlobalEnvVar``) are also excluded because the engine only seeds env-scope, so surfacing them would produce silent misses at scan time.