Try JFrog
API Reference
Contact SupportTry JFrog

Scan Artifact for Contextual Analysis

post
https://jf.example.com/xray/api/v1/artifact/contextualAnalysis/scan

Triggers a contextual analysis (applicability) scan. This endpoint supports two modes of operation:

Artifact mode - scan a specific artifact by providing repo and path (and optionally componentId). The artifact must already be scanned by Xray SCA.

Aggregate mode - scan all artifacts in a build or release bundle by providing the corresponding key pair instead:

  • For builds: build_name + build_number
  • For Release Bundles V1: release_bundle_name + release_bundle_version
  • For Release Bundles V2: release_bundle_v2_name + release_bundle_v2_version

The two modes are mutually exclusive. If repo, path, or componentId is provided, the request is treated as artifact mode and aggregate keys are ignored. If none of those are set, the request is treated as aggregate mode.

Optionally, project can be provided to scope the request to a specific project.

Requires the MANAGE_DATA permission. Since Xray 3.73.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Artifact mode: repository name containing the artifact.

string

Artifact mode: path to the artifact in the repository.

string

Artifact mode: component identifier (e.g. gav://log4j:log4j:1.2.17).

string

Project key to scope the request (optional, both modes).

string

Aggregate mode: build name.

string

Aggregate mode: build number.

string

Aggregate mode: Release Bundle V1 name.

string

Aggregate mode: Release Bundle V1 version.

string

Aggregate mode: Release Bundle V2 name.

string

Aggregate mode: Release Bundle V2 version.

Responses

Updated 25 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago