Scan Artifact for Contextual Analysis

Xray REST APIs

ft:sourceType
Paligo

Description: Start a Contextual Analysis scanning of a specific artifact.

Note: Only artifacts which are already scanned by Xray (for SCA - ‘regular’ scan) can be scanned.

Since: Xray 3.73.x

Security: Requires a valid user with the "Manage Xray Metadata" permission.

Usage: POST /api/v1/artifact/contextualAnalysis/scan

Required Parameters

Parameter

Type

Mandatory/Optional

Description

repo

String

Mandatory

The name of the repository of the artifact.

path

String

Mandatory

The artifact path in the repository.

Response Codes

Status Code

Description

200

OK

400

Bad request

404

Not found

Sample Request

{
  "repo": "my-repository",
  "path": "path-to/manifest.json"
}

Successful Response

200 OK
{}